# ION Manual > This file is very large and may be truncated. For an index of this content, please refer to https://docs.firstresonance.io/llms.txt instead. # Customize the login page Source: https://docs.firstresonance.io/administration/authentication-settings/customize-login-page Add your organization's logo and brand colors to the ION sign-in page. ## Customize the login page 1. In ION, go to **Settings > Organization > Authentication**. 2. In the **Login Page Branding** card, enter: * **Logo URL**: a publicly accessible URL to your logo image (for example, `https://example.com/logo.png`). * **Primary Color**: a hex color for buttons and accents (for example, `#16A34A`). * **Background Color**: a hex color for the page background (for example, `#FFFFFF`). 3. Click **Save Branding**. # Enforce MFA Source: https://docs.firstresonance.io/administration/authentication-settings/enforce-mfa Require multi-factor authentication for everyone in your organization or just yourself. With MFA required, users set up multi-factor authentication and use it each time they sign in. A user who hasn't set it up yet is prompted at their next sign-in. For how sign-in works, see the [authentication overview](/administration/authentication-settings). ## Enforce MFA for all users 1. In ION, go to **Settings > Organization > Authentication**. 2. In the **Multi-Factor Authentication** card, turn on **Require MFA for all users**. > [!WARNING] > > Org-wide MFA applies to everyone the moment you turn it on. To avoid locking > users out, confirm your team can enroll an authenticator app, and validate the > change in a sandbox tenant first if you have one. ## Enforce MFA for yourself You can enable MFA on your own profile without org-wide enforcement enabled. After enabling, log out and sign back in to start the MFA setup flow. If you lose access to your MFA device, see [Troubleshooting sign-in issues](/administration/authentication-settings/sign-in#troubleshooting). # Overview Source: https://docs.firstresonance.io/administration/authentication-settings/index How authentication works in ION: email and password or SSO, and the domain verification that ties users to your organization. ION identifies every user by their company email address. When someone [signs in](/administration/authentication-settings/sign-in), ION looks at the email's domain to decide what happens next: if the domain has an SSO connection, ION redirects to your identity provider to authenticate; otherwise the user enters an ION password. Everything you configure on the **Settings > Organization > Authentication** page shapes that flow: which domains belong to your organization, whether SSO is on, whether MFA is required, and what the sign-in page looks like. ## Two ways to sign in * **Email and password**: ION manages the credential. New users get an invite email with a link to set their password, and a forgotten password is [reset from the sign-in page](/administration/authentication-settings/reset-your-password). * **Single sign-on (SSO)**: your identity provider manages the credential. ION creates a user profile automatically on first SSO sign-in with the default **User** role, and removing someone from your IdP stops their SSO access to ION. Passwords, in this case, are reset in your IdP, not in ION. For connecting and maintaining an IdP, see the [SSO overview](/administration/authentication-settings/sso). The two coexist per domain, not per user: once SSO is active for a verified domain, users on that domain are routed to the IdP. ## Domains A claimed, verified domain tells ION that email addresses on that domain belong to your organization. Verification works by DNS: ION gives you a TXT record to publish, then confirms you own the domain. A verified domain acts as an allowlist that associates matching users with your organization at sign-up, and it's the prerequisite for SSO. See [Manage domains](/administration/authentication-settings/manage-domains). # Manage domains Source: https://docs.firstresonance.io/administration/authentication-settings/manage-domains Claim and verify your company's email domain so ION can route users to your organization at login. A verified domain is required before you can set up enterprise SSO or automatic user provisioning. For what domain verification does, see the [Overview](/administration/authentication-settings). > [!WARNING] > > Coordinate a full domain change, such as migrating your organization to a new company email domain, with [First Resonance support](https://support.firstresonance.io) in advance. Claiming a new domain associates matching users with your organization going forward. It doesn't move your existing users, who keep signing in with their current email addresses until each account is updated individually. ## Add a domain 1. In ION, go to **Settings > Organization > Authentication**. 2. In the **Domain Management** card, enter your domain in the **Add Domain** field and click **Add Domain**. The domain appears in your **Claimed Domains** list with a **Pending** status. ## Verify the domain After you add a domain, ION displays the name and value of a DNS TXT record to publish. 1. Give the TXT record name and value to whoever manages your DNS, and have them add it to the domain's DNS settings. 2. Once the record is live, click **Check Verification** next to the domain. ION checks for the record and updates the domain's status. DNS changes can take a few minutes to propagate. If verification is still **Pending**, wait and try again. ## Domain statuses | Status | Meaning | | - | - | | **Verified** | Ownership confirmed. ION routes users on this domain to your organization. | | **Pending** | Waiting on the DNS record, or DNS hasn't propagated yet. | | **Failed** | ION couldn't find the expected TXT record. Double-check the record and click **Check Verification** again. | ## Remove a domain 1. In the **Domain Management** card, click the remove icon next to the domain. 2. In the **Remove domain** dialog, click **Remove domain** to confirm. > [!WARNING] > > Removing a domain means users with email addresses on that domain are no longer automatically associated with your organization at login. Only remove a domain you no longer use. If you're transferring your organization to a different domain, move accounts over before you remove the old domain. # Reset your password Source: https://docs.firstresonance.io/administration/authentication-settings/reset-your-password How to reset a forgotten ION password from the sign-in page. 1. On the ION sign-in page, click **Don't remember your password?** 2. Enter your email address and submit. 3. Check your inbox for a reset email from `invites@firstresonance.io` and follow the link to set a new password. If your organization uses SSO, reset your password in your identity provider, not in ION. > [!NOTE] > > If the reset email doesn't arrive, check your spam folder. IT teams: allowlist `invites@firstresonance.io` to ensure password reset and invite emails are delivered. # Sign in to ION Source: https://docs.firstresonance.io/administration/authentication-settings/sign-in How to sign in to ION with email and password or single sign-on. Go to your organization's ION URL and enter your **company email address**, then click **Continue**. ION either prompts you for your ION password or, if your email domain uses SSO, redirects you to your identity provider and back. For how this routing works, see the [Overview](/administration/authentication-settings). ## Sign in for the first time With SSO, just sign in through your identity provider. The very first person to sign in to a new ION organization becomes its administrator; every subsequent user gets the default **User** role, which an admin can extend. With email and password, an administrator at your company sends you an invite email with a link to set your password. ## Troubleshooting > [accordion] I'm told I'm not authorized to access the application > > Verify that you're signing in at the app URL for your region, or at your sandbox URL. For the URLs, see [ION environments](/getting-started/ion-basics#ion-environments). > [accordion] My company is new to ION and I can't sign in for the first time > > Your ION environment might still be setting up. Wait 15 minutes and try again. > [accordion] My account has been deactivated > > Contact an administrator at your company to reactivate your ION account. > [accordion] You have no roles error > > A required permission isn't enabled for your role. An admin can grant it. See [Create a role](/administration/users-and-permissions/manage-roles). > [accordion] I need to reset my MFA and can't access my authenticator device > > Contact [support](https://support.firstresonance.io/) to reset it. # Disable SSO Source: https://docs.firstresonance.io/administration/authentication-settings/sso/disable-sso Turn off your SSO connection so users sign in with email and password instead. For what disabling SSO means for your team, see the [Overview](/administration/authentication-settings). > [!WARNING] > > Disabling SSO removes the connection entirely. Turning SSO back on later > requires running the setup wizard again. Anyone already signed in stays signed > in until their session ends. ## Disable SSO 1. In ION, go to **Settings > Organization > Authentication**. 2. In the **Enterprise SSO** card, click **Disable SSO**. # Overview Source: https://docs.firstresonance.io/administration/authentication-settings/sso/index The life of an SSO connection in ION: set it up, keep its certificate current, and retire it. An SSO connection hands authentication to your identity provider (Okta, Microsoft Entra ID, Google Workspace, ADFS, or another SAML or OIDC provider) and has a life beyond initial setup: 1. **Set up**: after verifying your domain, you connect your IdP through a self-service wizard that exchanges SAML or OIDC details and maps user attributes. See [Set up SSO](/administration/authentication-settings/sso/set-up-sso). 2. **Maintain**: SAML connections verify each login against your IdP's signing certificate. When that certificate expires or your security team rotates it, you update ION with the new one, coordinated with the IdP switch. OIDC keys rotate automatically. See [Rotate your SAML signing certificate](/administration/authentication-settings/sso/rotate-saml-certificate). 3. **Retire**: disabling SSO removes the connection and returns your team to email and password sign-in without deleting any accounts. See [Disable SSO](/administration/authentication-settings/sso/disable-sso). > [!WARNING] > > A misconfigured SSO connection or an out-of-sync certificate rotation blocks fresh sign-ins to production. Validate authentication changes in a sandbox tenant when you have one, and keep the previous certificate on hand during a rotation. # Rotate your SAML signing certificate Source: https://docs.firstresonance.io/administration/authentication-settings/sso/rotate-saml-certificate Replace an expiring or rotated SAML signing certificate on your SSO connection without opening a support ticket. This page applies to SAML connections only. OIDC connections have no signing certificate to rotate. For how certificate rotation fits into the SSO lifecycle, see the [Overview](/administration/authentication-settings). ## When you'll need to do this * **Certificate expiry.** Most IdP signing certificates are valid for one to three years. Your IdP or security team issues a replacement before the old one expires. * **Scheduled key rotation.** Routine security hygiene, or a response to a suspected key compromise. * **IdP changes.** Switching identity providers, or upgrading the signing algorithm (for example, moving from SHA-1 to SHA-256). * **Auto-rolled keys.** Your IdP changed its signing key on its own (for example, Microsoft Entra auto-rolled its certificate). ## Before you start The **Rotate certificate** button is only visible to org administrators with SSO management permission. > [!WARNING] > > ION holds one signing certificate per connection at a time. There's no overlap > period where both the old and new certificates are valid. New sign-ins briefly > fail in the window between your IdP switching to the new key and ION being > updated to match. Anyone already signed in stays signed in; the certificate is > only checked on fresh logins. Keep your previous certificate available until you've confirmed a successful login. Rolling back means pasting the old certificate back. ## What you'll need From your IdP administrator, get one of the following for the new certificate: * The new **X.509 certificate** in PEM format (a text block beginning with `-----BEGIN CERTIFICATE-----`), or * Your IdP's **SAML 2.0 metadata XML** (beginning with ` Organization > Authentication**. 2. In the **Enterprise SSO** card, click **Rotate certificate**. 3. Paste the new PEM certificate or SAML metadata XML into the dialog, or use **Upload from file** to select it. 4. Have your IdP administrator activate the new signing key. 5. Click **Rotate**. ION immediately starts verifying logins with the new certificate and displays a SHA-256 fingerprint of the new certificate. > [!NOTE] > > ION's fingerprint is SHA-256, but most IdP consoles (Okta, Microsoft Entra, > ADFS) display a SHA-1 thumbprint, so the two won't match by eye even when > everything is correct. To compare, generate the SHA-256 yourself: `openssl > x509 -noout -fingerprint -sha256 -in cert.pem`. 6. Ask someone (not yourself) to sign out and sign back in through SSO to verify the new certificate works. ## If sign-ins start failing This is recoverable, and it does not affect anyone already signed in. * **Most likely cause**: ION and your IdP are temporarily out of sync. One is using the new certificate and the other is still on the old one. * **Fastest fix**: open **Rotate certificate** again and paste the previous certificate back. New sign-ins recover immediately. Then retry the rotation once both sides are ready to switch together. * If logins still fail after both sides are confirmed on the new certificate, [contact support](https://support.firstresonance.io/) with the fingerprint ION displayed and the time of the change. ## Frequently asked questions > [accordion] Will this log everyone out? > > No. The signing certificate is only checked when someone signs in fresh. Everyone with an active session keeps working uninterrupted. > [accordion] Can I load the new certificate ahead of time? > > Not without a brief interruption. Because ION holds only one certificate at a > time, loading the new one before your IdP starts signing with it causes new > sign-ins to fail until the IdP catches up. Switch both sides together instead. > [accordion] What if I don't see the Rotate certificate button? > > The action is restricted to administrators with SSO management permission. Ask > an admin on your team, or [contact > support](https://support.firstresonance.io/). > [accordion] PEM or metadata XML: which should I use? > > For a routine certificate swap, paste the PEM. It updates only the signing > certificate and leaves the rest of your connection untouched. Use metadata XML > only when you intend to refresh the whole connection (new endpoints or > attribute mappings). > [accordion] My IdP is rolling over and has two certificates. Which do I use? > > Paste the certificate your IdP will sign with after the cutover, coordinated > with the switch. > [accordion] What exactly does this rotate? > > This action updates only the IdP signing certificate ION uses to verify login tokens. It does not change ION's request-signing certificate or any assertion-encryption keys. If you need to rotate those, contact [support](https://support.firstresonance.io/). ## Provider-specific notes > [accordion] Microsoft Entra ID (Azure AD), including GovCloud > > Entra downloads its certificate as a binary `.cer` (DER) file. Convert it to PEM, or use the federation metadata. Entra auto-rolls its signing certificate and lists multiple certificates in its federation metadata during the overlap, so paste the one it will use after the switch. GovCloud tenants live under `login.microsoftonline.us`. > [accordion] Okta > > Generate the next certificate in Okta, then paste its signing certificate > (PEM) or Okta's metadata URL/file. Okta metadata lists both encryption and > signing certificates. ION automatically picks the signing one. > [accordion] ADFS > > ADFS's AutoCertificateRollover publishes a primary and secondary token-signing > certificate, exported as binary `.cer` (DER). Convert to PEM and paste the one > that will be primary after the rollover. > [accordion] Google Workspace / other SAML providers > > Download the SAML app's signing certificate as PEM and paste it. If your provider only offers metadata, paste the metadata XML. # Set up SSO Source: https://docs.firstresonance.io/administration/authentication-settings/sso/set-up-sso Connect your identity provider to ION so your team can sign in with their existing company credentials. For how SSO fits into ION authentication, including how accounts are provisioned on first sign-in, see the [Overview](/administration/authentication-settings). ## Before you start [Claim and verify your email domain](/administration/authentication-settings/manage-domains) before setting up SSO. To manage authentication settings, your role needs the **CreateOrganizationDomain** permission, in the **OrganizationDomain** group. Without it, the page says you don't have permission to manage authentication settings. An admin can grant it. See [Manage role permissions](/administration/users-and-permissions/manage-role-permissions). Adding SSO after you onboard many users means reconciling existing accounts with your identity provider. > [!WARNING] > > A misconfigured SSO connection can lock users out of production. If you have a sandbox tenant, validate the connection there before enabling it in production. ## Set up SSO 1. In ION, go to **Settings > Organization > Authentication**. 2. In the **Enterprise SSO** card, click **Configure SSO**, then click **Open SSO Setup Wizard** and follow the steps to connect your identity provider. The wizard walks you through selecting your provider, exchanging SAML or OIDC details, mapping user attributes, and enabling the connection. 3. When the wizard is complete, return to ION and click **Check Status**. Once your IdP connection is live, the card shows **SSO Active** with your provider and connection name. You can hand the setup wizard link to whoever manages your IdP if you don't have access to configure it yourself. > [!NOTE] > > The wizard shows you the values to enter into your identity provider and collects your provider's metadata or signing certificate directly. You don't need to send anything to First Resonance to complete setup. For more information, see Auth0's [self-service SSO documentation](https://auth0.com/docs/authenticate/enterprise-connections/self-service-SSO). ## Troubleshooting > [accordion] Check Status shows the connection is not active after completing the wizard > > The wizard must fully complete and the connection must be enabled before ION can verify it. Return to the wizard and confirm the final step shows the connection as enabled, then try **Check Status** again. > [accordion] Users get an error or are redirected back to the ION login page after attempting SSO > > Confirm your email domain is claimed and verified in ION before enabling SSO. See [Manage domains](/administration/authentication-settings/manage-domains). Unverified domains won't route users to your IdP. > [accordion] Attribute mapping errors or users are created without the correct name or email > > Check the attribute mapping step in the wizard. ION expects the email attribute to be mapped correctly from your IdP. For SAML providers, the email attribute is typically `email` or `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`. Confirm with your IdP's documentation. > [accordion] SSO was working and stopped after a certificate rotation > > If your IdP uses SAML and rotated its signing certificate, ION needs to be updated with the new certificate. See [Rotate your SAML signing certificate](/administration/authentication-settings/sso/rotate-saml-certificate). ## Provider-specific notes These notes cover what's specific to the most common providers. > [accordion] Okta > > Create a **SAML 2.0** app integration in Okta and paste in the **Single sign-on URL** and **Audience URI (SP Entity ID)** the wizard displays. They take the form `https://firstresonance.auth0.com/login/callback?connection=` and `urn:auth0:firstresonance:`, with the connection name filled in by the wizard. Okta sends the user's `email` in the SAML assertion by default. When you provide Okta's metadata, ION automatically picks the **signing** certificate if both signing and encryption certificates are listed. Background: [Auth0 community guide to Okta as the SAML IdP](https://community.auth0.com/t/saml-setup-okta-as-idp-and-auth0-as-sp/91164). > [accordion] Microsoft Entra ID (Azure AD) > > Register the application in the Microsoft Entra admin center using the **Reply URL (ACS)** the wizard displays, then provide your application's **federation metadata** (URL or XML) back in the wizard. Confirm Entra releases the user's **email** claim. **GovCloud** tenants sign in under `login.microsoftonline.us`. Entra **auto-rolls** its signing certificate and lists multiple certificates during the overlap. This matters when you later [rotate the signing certificate](/administration/authentication-settings/sso/rotate-saml-certificate). > > To use [export control](/administration/organization-settings/configure-export-control), Entra must send each group by its name. Entra sends group object IDs by default, and ION never matches an ID. For an OIDC connection, add the groups claim to the **ID** token. Entra sends cloud-only group names only for **Groups assigned to the application**, so assign your export group to the application. For the manifest settings, see Microsoft's [Configure groups optional claims](https://learn.microsoft.com/en-us/entra/identity-platform/optional-claims#configure-groups-optional-claims). > [accordion] ADFS > > Configure the relying party in ADFS following [Auth0's ADFS connection documentation](https://auth0.com/docs/connections/enterprise/adfs), using **Realm Identifier** `urn:auth0:firstresonance` and **Endpoint** `https://firstresonance.auth0.com/login/callback`. Then provide your ADFS **federation metadata URL** (for example, `https://adfs.yourcompany.com/FederationMetadata/2007-06/FederationMetadata.xml`) in the wizard. # Custom attributes Source: https://docs.firstresonance.io/administration/custom-attributes Add org-defined metadata fields to ION records (procedures, runs, parts, issues, and more) from Settings. Custom attributes let you capture additional metadata on ION records beyond the default fields. They are available for the following entity types: | Entity | Where in Settings | | - | - | | Procedures | **Settings > Production > Procedures** | | Standard steps | **Settings > Production > Standard Steps** | | Runs | **Settings > Production > Runs** | | Issues | **Settings > Quality > Issues** | | Parts | **Settings > Supply Chain > Parts** | | Purchases | **Settings > Supply Chain > Purchases** | | Receipts | **Settings > Supply Chain > Receipts** | | Suppliers | **Settings > Supply Chain > Suppliers** | | Part kits | **Settings > Supply Chain > Part Kits** | | Locations | **Settings > Supply Chain > Locations** | | Parts Inventory | **Settings > Supply Chain > Parts Inventory** | | Plans | **Settings > Supply Chain > Plans** | | Further Actions | **Settings > Quality > Further Actions** | The **Purchases** page defines two separate attribute sets: **Purchase Order Attributes** apply to the order, and **Purchase Order Line Attributes** apply to each line on the order. ## Add a custom attribute To add a custom attribute: 1. Go to the Settings page for the entity you want to extend (see table above). 2. In the **Attributes** section, enter a **Name** for the attribute. 3. Select a **Type** from the dropdown. 4. Click **Add**. The attribute is saved immediately. ### Attribute types The **Type** dropdown lists these options. After you save the attribute, ION shows the type as a badge, which can use a different label than the dropdown option. | Dropdown option | Badge label | Description | | - | - | - | | **String** | String | Free-text input. | | **Number** | Number | Numeric value. | | **Boolean** | Boolean | On or off toggle. | | **Datetime** | Date & Time | Date and time picker. | | **FileAttachment** | File | File attachment. | | **Select** | Select | Single-choice dropdown. You define the options after creation. | | **Multiselect** | Multi-Select | Multiple-choice dropdown. You define the options after creation. | | **ION: Locations** | ION: Locations | Reference to a location record. | | **ION: Parts** | ION: Parts | Reference to a part record. | | **ION: Projects** | ION: Projects | Reference to a project record. | | **ION: Users** | ION: Users | Reference to a user. | ## Manage options for select and multi-select attributes Select and multi-select attributes require you to define their options separately after creation. Options follow an archive-then-delete lifecycle: archiving takes an option out of circulation while leaving the records that already use it intact, and permanent deletion is only available once an option is archived. To manage an attribute's options: 1. In the **Attributes** section, find the attribute and click the expand arrow next to it. 2. To add an option, type the option name in the input field and press **Enter** or click **Add**. 3. To archive an option, click the **Archive** icon on the option. 4. To work with an option you already archived, expand **Archived** and use one of the icons on the option: * The **Unarchive** icon returns the option to the active list. * The **Delete permanently** icon removes the option from the attribute. A record that already holds an archived option keeps that value. ![Expanded Finish attribute of type Select showing an input reading Type option name and press Enter, an Add button, active options Anodized and Powder Coat each with an archive icon, and an ARCHIVED (1) list containing the struck-through option Bare with an unarchive icon and a delete icon](https://mintcdn.com/firstresonance/Y69-6sOEJAez7m7g/images/administration/custom-attribute-archived-options.png?fit=max\&auto=format\&n=Y69-6sOEJAez7m7g\&q=85\&s=97ff00c9b9fb5bcbd7e6ea7d6a7a293c) An expanded select attribute with active and archived options. > [!WARNING] > > Deleting an archived option can't be undone. ION blocks the deletion if any > record still holds the option, so archive it instead when you need to retire an > option that's in use. ## Edit a custom attribute The name and type of a custom attribute can't be changed after creation. To rename an attribute or change its type, archive the attribute, delete it, and create a new one. For **Select** and **Multi-Select** attributes, you can add and archive options at any time. For more information, see [Manage options for select and multi-select attributes](#manage-options-for-select-and-multi-select-attributes). ## Archive a custom attribute Archiving an attribute hides it from data entry across ION: it stops appearing on create forms, table column pickers, and the panels that add an attribute to a record. Records that already carry a value for the attribute keep it, and you can still edit that value. 1. In the **Attributes** section, find the attribute you want to archive. 2. Click the **Archive** icon at the end of the attribute row. To bring an attribute back, expand **Archived** and click the **Unarchive** icon on the attribute row. ## Delete a custom attribute Delete is only available on an archived attribute, so archive it first. To delete a custom attribute: 1. In the **Attributes** section, expand **Archived**. 2. Click the delete button on the attribute row. 3. In the **Delete Attribute** dialog, click **Delete**. ## Set an attribute on several records at once You can set a custom attribute on many records in one step from these tables: **Inventory**, **Purchases**, a purchase order's lines, **Receipts**, **Kits**, **Suppliers**, and the locations table in **Factory**. 1. On the table, select the records. 2. In the toolbar, click **Change Attributes**. 3. Pick the attribute and set its value. ION applies it to every selected record. ## Archived values on records When a record holds an archived option, ION asks you to confirm in the **Deselect archived option?** dialog before it removes the value. You can't select an archived option again. ## How attribute values copy between records When you duplicate a record, ION carries its custom attribute values to the new record in these cases: * Splitting an inventory line copies the parent's attribute values to the new line. * Copying a purchase order copies attribute values on both the order and its lines. * Creating a new part revision copies the source revision's attribute values. # Customer S3 Delivery Setup Source: https://docs.firstresonance.io/administration/customer-s3-delivery-setup Set up an S3 bucket in your AWS account to receive automated data snapshots from ION. ## Overview ION delivers automated data snapshots directly to an S3 bucket in your AWS account as `.tar` archives, once you set up the bucket and grant First Resonance access to write to it. ## What you need * An S3 bucket in your AWS account * An IAM role that First Resonance assumes to write to your bucket * An external ID (provided by First Resonance) for secure role assumption ## Set up delivery **1. Create an S3 bucket** Create a bucket in your preferred AWS region, either through the AWS console or using the CLI: ```bash theme={null} aws s3 mb s3:// --region ``` We recommend enabling: * **Versioning**: protects against accidental overwrites. * **Server-side encryption** (SSE-S3 or SSE-KMS): encrypts data at rest. **2. Create an IAM role** Create an IAM role that First Resonance assumes to deliver snapshots to your bucket. ### Trust policy The trust policy allows First Resonance to assume the role using an external ID. Replace `` with the First Resonance AWS account ID for your environment (provided by your account team), and `` with the external ID we provide. ```json theme={null} { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam:::root" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "" } } } ] } ``` The external ID prevents the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html) and ensures only First Resonance can assume this role. ### Permission policy Attach the following policy to the role. Replace `` with your bucket name. ```json theme={null} { "Version": "2012-10-17", "Statement": [ { "Sid": "SnapshotDeliveryBucketAccess", "Effect": "Allow", "Action": [ "s3:GetObject", "s3:PutObject", "s3:DeleteObject", "s3:AbortMultipartUpload", "s3:ListBucketMultipartUploads", "s3:ListMultipartUploadParts", "s3:ListBucket" ], "Resource": [ "arn:aws:s3:::", "arn:aws:s3:::/*" ] } ] } ``` > [!NOTE] > > `s3:PutObject` handles the core upload. The additional permissions allow First Resonance to clean up incomplete uploads and list bucket contents for verification. **3. Send your configuration** Provide the following details to your account team: | Field | Description | | - | - | | Bucket name | Your S3 bucket name. | | Bucket region | The AWS region where your bucket is located. | | Role ARN | The full ARN of the IAM role you created. | First Resonance provides the external ID and configures your snapshot schedule. **4. Validation** After we receive your configuration, our system validates access by: 1. Assuming the IAM role with the external ID. 2. Verifying the bucket exists and is accessible. 3. Writing and deleting a small test object. If validation fails, we reach out with the specific error so you can adjust permissions. ## What gets delivered Each snapshot creates files under your bucket with this structure: ``` s3:/// └── / └── / ├── snapshot_tables_.tar └── snapshot_attachments_.tar ``` For large snapshots that are split into multiple files, each file includes a part number (for example, `snapshot_tables_part1_.tar` and `snapshot_tables_part2_.tar`). * **snapshot_tables**: all database tables as compressed CSV files, bundled into a tar archive. * **snapshot_attachments**: file attachments bundled into a tar archive. ## Troubleshooting > [accordion] Role assumption fails (AccessDenied) > > **Cause:** Trust policy does not allow the First Resonance account. > > **Fix:** Verify the `Principal` in the trust policy matches the account ID provided by your account team. > [accordion] Role assumption fails with correct principal > > **Cause:** External ID mismatch. > > **Fix:** Verify the `sts:ExternalId` condition matches the value provided by First Resonance. > [accordion] Access denied to bucket > > **Cause:** Missing or incorrect permission policy. > > **Fix:** Verify the permission policy is attached to the role and the bucket name matches. > [accordion] Test write fails (AccessDenied) > > **Cause:** Role lacks `s3:PutObject` permission. > > **Fix:** Check the permission policy includes `PutObject` on the bucket resource. > [accordion] Bucket does not exist > > **Cause:** Wrong bucket name or region. > > **Fix:** Verify the bucket name and that it exists in the expected region. ## Security notes * First Resonance uses **STS AssumeRole** with short-lived credentials that are automatically refreshed during long-running snapshots. No credentials are stored. * First Resonance only writes to your tenant's prefix and does not read or modify other data in your bucket. * All data is transmitted over HTTPS (TLS). # Data Snapshots Source: https://docs.firstresonance.io/administration/data-snapshots Create a full snapshot of your organization's data and attachments from ION for backup, compliance, or analytics purposes. ## Overview Data snapshots let you create a complete copy of your organization's data from ION. By default, a snapshot includes both: * **Tables**: all of your organization's structured data, such as parts, inventory, BOMs, runs, and issues. * **Attachments**: all documents, images, and other files uploaded across ION, including those attached to runs, procedures, and issues. If needed, you can choose to snapshot only tables or only attachments. > [!NOTE] > > Data snapshots are available depending on your organization's plan and settings. To find out whether snapshots are enabled for your organization, contact your account team. ## How data snapshots work Data snapshots run automatically on a weekly or monthly cadence configured for your organization. To get started, reach out to your account team to set up your snapshot schedule and delivery destination. Once a snapshot completes, you can download the resulting files from the **data snapshots page**. > [!WARNING] > > The data snapshots page is only accessible to organization admins for security purposes. All snapshot data is encrypted at rest and in transit using TLS. ## What you receive Snapshots are delivered as `.tar` archives. A tables snapshot contains one compressed file per table (`.csv.gz` or `.jsonl.gz`), and an attachments snapshot contains all uploaded files. For large snapshots, ION automatically splits the output into multiple `.tar` files labeled with a part number, such as `snapshot_tables_part1_2026-03-31-143022.tar` and `snapshot_tables_part2_2026-03-31-143022.tar`. ## Delivery destinations By default, snapshots are stored in ION and made available for download through the UI. Snapshots stored in ION are retained for **30 days**, after which they are automatically deleted. > [!TIP] > > You can set up [Customer S3 delivery](/administration/customer-s3-delivery-setup) to have snapshots delivered directly to your own AWS S3 bucket. Delivering to your own bucket gives you ownership of the snapshot files and lets you apply your own retention and access policies. ## Onboarding To get started with data snapshots: 1. **Contact your account team.** Let them know you want to set up data snapshots and whether you need tables, attachments, or both. 2. **Choose a delivery destination.** Snapshots can be downloaded from ION directly, or delivered to your own S3 bucket. 3. **Set up customer-managed S3 delivery, if applicable.** Follow the [Customer S3 delivery setup](/administration/customer-s3-delivery-setup) guide to create your bucket, configure an IAM role, and share your configuration for validation. ## Snapshot history The data snapshots page shows the status of each snapshot: **Pending**, **In Progress**, **Completed**, or **Failed**. For a failed snapshot, check the error details. ![Data snapshots page with the download panel for a completed snapshot.](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/administration/data-snapshots-download.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=2b432bf8c312a21ae9412ff3a666d417) Data snapshots page with the download panel for a completed snapshot. # Export data Source: https://docs.firstresonance.io/administration/export-data Export ION data to CSV or Excel on demand or on a schedule, track each export job, and download the finished file. The Exports page delivers a data view from ION as a CSV or Excel file, either once on demand or on a recurring schedule. Each run of an export is a job whose status and output you can check from the export's detail page. ION can email the file to the recipients you set, or download it straight to your browser. ## Request an export 1. In ION, go to **OS > Exports**. 2. Click **New Export**. 3. In the **Create export** dialog, fill in: * **Name**: what to call this export. This field is required. * **View name**: the data view to export. Search your available views, or enter any view name you have access to. This field is required. * **Format**: **CSV** or **Excel**. * **Delivery**: how you get the file, **Email** or **Download**. This choice is available on the **Run once** tab; scheduled exports always deliver by email. * **Delivery recipients**: the email addresses that receive the file. At least one is required. This field appears only for **Email** delivery. 4. Choose when it runs: * On the **Run once** tab, click **Run now** to run the export immediately. With **Download** delivery, ION saves the file to your browser when it's ready. With **Email** delivery, ION emails it to the recipients. * On the **Schedule** tab, enter a **Cron expression** and pick a **Timezone**, then click **Save schedule** to run it on a recurring cadence. ION emails the recipients each time the file is ready. ## Manage exports Use the **Enabled** toggle to pause or resume a scheduled export. The actions menu on each row offers **Run now**, **View details**, **Enable** or **Disable**, and **Delete**. ## Check job status and download the file 1. On the **Exports** page, open the actions menu on an export and click **View details**, or click the export's name. 2. Under **Recent jobs**, each row is one run: * **Status**: **Pending**, **In progress**, **Completed**, or **Failed**. A failed job shows its error message under **Details**. * **Rows** and **Size**: what the job produced. 3. On a completed job, click **Download** to save the file. # As-built BOM imports Source: https://docs.firstresonance.io/administration/ion-importers/abom-installations Record installed parts on a received assembly from a CSV file. ## Overview The **As-built BOM (aBOM)** importer records installations onto an assembly you received already built, such as a PCBA from a contract manufacturer. Each row is one installation: the assembly's inventory record, the inventory record installed into it, and how much. For how the import wizard works, see [Importers](/administration/ion-importers). The importer never creates inventory. Both the assembly and every installed part must already exist as inventory records, and you reference them by inventory ID. The assembly's part must have a released mBOM, because that is what tells ION which positions the parts install into. When the assembly has no as-built structure yet, ION builds one from its mBOM before installing. > [!WARNING] > > An import onto an assembly that already has parts installed on it is rejected, because it would install those parts a second time. Uninstall the existing parts before you import again. Parts that ION installs on made-on-assembly positions by itself don't count. ## Columns | Column | Required | Description | | - | - | - | | `root_inventory_id` | Yes | Inventory ID of the assembly being installed into. | | `installed_inventory_id` | Yes | Inventory ID of the part being installed. | | `quantity` | Yes | How much of the installed inventory goes into the assembly. Must be a number. | | `reference_designator` | No | The designator this installation fills, such as `U12`. Required only when the assembly's structure offers more than one position the part could fill. | ## How a row is matched to a position ION matches each row against the positions in the assembly's as-built structure: * A row matches a position that accepts the installed part. Substitutes and interchangeable revisions count, so an installed part does not have to be the exact part the mBOM names. * When several positions accept the part, `reference_designator` decides which one. Leave it out and the row fails, asking you to add one. ION never guesses. * A designator that no matching position has is a row error. * A made-on-assembly position can't receive an installation from this importer. ION installs those parts itself when it builds the assembly's structure. > [!NOTE] > > Rows are also checked against each other. Several rows drawing on the same lot can't together take more than the lot holds, and several rows can't overfill one reference designator. Depending on your settings, the importer also enforces [Require Install Intent Match](/administration/quality-settings/configure-intent-control-policies) and [Restrict installs to the assigned kit](/administration/supply-chain-settings/restrict-installs-to-the-assigned-kit) on each row. ## Errors The import is all-or-nothing: nothing is written unless every row resolves. Most errors are reported against the CSV row that caused them and name the value to fix, such as a `root_inventory_id` that isn't found, a `quantity` that isn't a number, or an assembly whose part has no released mBOM to build a structure from. An assembly that already has installed parts is reported for the whole file. If another import is writing to an assembly in the same file, the import fails. Wait for the other import to finish, then import again. ## Start the import from receiving On the [receiving page](/manage-supply-chain/receiving/receive-parts), the selected purchase order has an **Import as-built BOM** link that opens this importer in a new tab. Depending on your settings, the link appears only when imports are enabled for your organization. # Overview Source: https://docs.firstresonance.io/administration/ion-importers/index Use CSV imports to bulk-create or update records in ION. ION's import feature lets you upload a CSV file to create or update records in bulk. ## How imports work To start an import, navigate to **Imports** in the sidebar, then pick an import type from the **New Import** tab. Imports are processed **asynchronously**, so you can navigate away and continue working while the import runs. You receive a notification when the import completes or fails. Clicking **Start Import** on any card opens the import wizard, which walks you through **Upload**, **Match**, and **Review** steps. On the **Upload** step you can download the CSV template, toggle the importer's options (the option set varies by importer), or choose **Enter data manually** to type rows into the grid instead of uploading a file. The editable preview covers files up to 5,000 rows. Upload a larger file and ION says so, skips the **Match** and **Review** steps, and offers **Import file as-is**, which sends the file unedited. A file above 1,000,000 rows is rejected outright. The **Match** step maps your file's columns to ION fields. ION auto-maps each column to the field whose name it matches, and you can adjust any mapping in that column's **Maps To** dropdown: pick a different field, keep the column as a custom attribute, or skip the column so it isn't imported. Required fields must stay mapped. When you enter data manually instead of uploading, this step becomes a column picker where you choose which fields to include. On the **Review** step, ION shows your rows in an editable grid. Edit any cell inline, then use the validate control to check the data. ION flags each failing cell with its error and highlights the affected rows, so you can fix them and revalidate before importing. Editing a validated file prompts you to revalidate before you can import. ![Import wizard Review step showing an editable grid with three rows flagged Name is required and a banner reading 3 issues in rows 1, 2, 3](https://mintcdn.com/firstresonance/Sz_vZtaxyNMzjHVb/images/administration/ion-importers/import-wizard-review-errors.png?fit=max\&auto=format\&n=Sz_vZtaxyNMzjHVb\&q=85\&s=0cf30dec7b264636261be02c14b53646) The Review step flags each failing cell so you can fix it before importing. Imports are **all-or-nothing**. If any row fails validation, no rows are written and you receive an error report. You can track the status of all imports from the **Import History** tab. Expand any failed job to see its per-row error messages, or click **Download** to pull the full error CSV. ## Video walkthrough This walkthrough uses the mBOM importer as an example. [https://www.loom.com/embed/34129c65cde941189007b971c80382d0](https://www.loom.com/embed/34129c65cde941189007b971c80382d0) ## Required and optional columns Each import type has its own set of columns. Some columns are required and must be present in every row, while others are optional. Optional columns that you omit from your CSV are skipped entirely, so ION does not touch those fields on the imported records. Only when an optional column is included in the CSV but left blank for a given row does ION apply a default value based on the field type (see below). If a required column is missing or empty, the import fails with a validation error. ## How empty CSV cells are handled When an optional column is present in your CSV but a row leaves it blank, the cell defaults to a falsy or zero-equivalent value (not null). Omitting the column entirely leaves the field untouched. ### Lookup and control columns are exempt A handful of columns are exempt from the falsy-default rule, either because they're used to look up an existing record or control importer behavior, or because `0` isn't a falsy value for that field's type. For these, an empty cell means "not provided": | Column | Importer | Empty cell means | | - | - | - | | `id` | [Part Inventory](/administration/ion-importers/part-inventory), [Tool Inventory](/administration/ion-importers/tool-inventory), [Issues](/administration/ion-importers/issues) | Create a new record (no update lookup) | | `original_name` | [Locations](/administration/ion-importers/location-imports) | No rename | | `original_po_number` | [Purchase Orders](/administration/ion-importers/purchase-orders) | No rename | | `latitude`, `longitude` | [Locations](/administration/ion-importers/location-imports) | Unset. `0` is not a falsy value for a coordinate | | `can_hold_inventory`, `pickable` | [Locations](/administration/ion-importers/location-imports) | Keep the field's default of `true`, rather than flipping to `false` like other booleans | | `last_maintained_date`, `uri` | [Tool Inventory](/administration/ion-importers/tool-inventory) | Unset. No date is written and no URI is stored | | `due_date`, `quantity`, `assigned_to` | [Runs](/administration/ion-importers/runs) | Unset. No due date, quantity, or assignee is written | Each importer's column table calls out which fields behave this way. | Field Type | Empty Cell Value | Examples | | - | - | - | | Text | `""` | `description`, `address` | | Numeric | `0` | `quantity` | | Boolean | `false` | `made_on_assembly`, `available`, `archived` | > [!NOTE] > > To set a field to true, you must explicitly write a truthy value. ### Accepted boolean values Boolean fields accept any of the following (case-insensitive): | Truthy | Falsy | | - | - | | `true` | `false` | | `yes` | `no` | | `1` | `0` | ## Errors When validation fails, ION reports up to **5,000 errors** with the specific row number and a description of the problem. Row numbers correspond to the CSV file where row 1 is the header and row 2 is the first data row. > [!NOTE] > > If your file contains more than 5,000 errors, ION stops scanning at that point. Fix the reported batch and re-upload to see the rest. > [!TIP] > > Review your column headers and values before uploading. Because imports are all-or-nothing, resolve every error the **Review** step flags and revalidate until the file passes before you re-upload. Run your import in a staging environment and verify the results before importing into production. # Issue imports Source: https://docs.firstresonance.io/administration/ion-importers/issues Create or update issues from a CSV file, including dispositions, assignees, and custom attributes. ## Overview The Issues importer bulk-creates or updates issues. The distinction is row-by-row: * Rows **without** an `id` value **create** a new issue. `title` is required, and the issue starts at status `pending` unless the row sets an explicit `status`. * Rows **with** an `id` value **update** the matching issue. ## Columns | Column | Required | Description | | - | - | - | | `id` | No | Issue ID. Provide to update an existing issue; omit to create a new one. **Lookup column**: an empty cell is treated as "not provided," not `0`. | | `title` | Yes (for create) | Issue title. | | `status` | No | One of `pending`, `in_progress`, `in_review`, `resolved`. Matched case-insensitively. | | `cause_condition` | No | Plain-text cause description. See [Rich-text fields](#rich-text-fields). | | `disposition` | No | Plain-text disposition description. See [Rich-text fields](#rich-text-fields). | | `expected_condition` | No | Plain-text expected-condition description. See [Rich-text fields](#rich-text-fields). | | `issue_disposition_type` | No | Title of a disposition type configured in your organization. Matched case-insensitively. | | `assigned_to` | No | Email address of the user to assign. Matched case-insensitively against existing users. | ## Rich-text fields `cause_condition`, `disposition`, and `expected_condition` are rich-text fields in the ION UI. The importer accepts plain text and converts it into a single paragraph, which you can elaborate on later in the UI. On update rows, an empty cell leaves the existing content untouched. ## Custom attributes Any column not in the standard list above is treated as a custom attribute on the issue. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. # Kit Item Imports Source: https://docs.firstresonance.io/administration/ion-importers/kit-items Bulk-add or update the part requests on existing kits from a CSV file. ## Overview The Kit Items importer adds part requests to **existing kits**, one CSV row per requested part, with the target kit identified by `kit_id`. A single file can target any number of kits. Rows upsert on the kit and the part together. A row whose kit already requests that part updates the request's quantity, keeping any inventory already kitted against it; a row naming a pair the kit doesn't hold creates the request. There is no column for an existing request's own id. ``` kit_id | part_number | revision | quantity 1042 | PN-000123 | A | 4 1042 | PN-000456 | | 1 1043 | PN-000123 | A | 2 ``` To import into one kit, open the kit and select **Import Parts from CSV** in the **Add Part to Kit** menu. The import then fills `kit_id` with that kit, so your file can leave the `kit_id` column out. A file of more than 5,000 rows is uploaded without that step, so it needs its own `kit_id` column. The import runs in the background. ## Columns The header set is closed. A column outside this list fails the import rather than being skipped. | Column | Required | Description | | - | - | - | | `kit_id` | Yes | Numeric ID of the kit to add the part request to. | | `part_number` | Yes | Part number of the requested part. | | `revision` | No | Part revision. Leave blank, or leave the column out, to use the part's latest revision. | | `quantity` | Yes | Requested quantity. | ION also accepts `kit id`, `kit-id`, `part number`, and `part-number` as header spellings. > [!WARNING] > > A header-only file is rejected rather than completing as an import that changed nothing. > [!NOTE] > > This importer does not support custom attributes. # Location imports Source: https://docs.firstresonance.io/administration/ion-importers/location-imports Import factory locations from a CSV file, including nested hierarchies, supervisors, and custom attributes. ## Overview Location imports let you bulk-create or update factory locations. Column headers are matched case-insensitively and extra whitespace is trimmed. ## Columns | Column | Required | Description | | - | - | - | | `name` | Yes | Location name. Must be unique within the CSV and cannot exceed 128 characters. | | `original_name` | No | If renaming an existing location, this is the current name in ION. Max 128 characters. **Lookup column**: an empty cell means "no rename," not `""`. | | `parent_name` | No | Name of the parent location. Used to build nested hierarchies. | | `description` | No | Description of the location. Max 512 characters. | | `address` | No | Physical address. Max 128 characters. | | `available` | No | Whether the location is available. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `archived` | No | Whether the location is archived. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `exclude_from_merge_part_inventory` | No | Exclude this location from merged part inventory views. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `can_hold_inventory` | No | Whether the location is a valid destination for inventory. Boolean field. **Default-true column**: an empty cell keeps the current value rather than setting `false`. | | `pickable` | No | Whether kitting can pull from the location. Boolean field. **Default-true column**: an empty cell keeps the current value rather than setting `false`. | | `latitude` | No | Latitude coordinate. Must be between -90 and 90. Empty cells are treated as unset (not `0`). | | `longitude` | No | Longitude coordinate. Must be between -180 and 180. Empty cells are treated as unset (not `0`). | | `type` | No | Location type. One of `workcenter`, `tote`, `warehouse`, `rack`, or `shelf`. | | `supervisor` | No | Email address of the supervisor. Must match an existing user in ION. | ## Custom attributes Any columns beyond the standard set are matched against your organization's custom location attributes. If a column header does not match a standard column or a configured custom attribute, the import will fail with a validation error. ## Parent-child hierarchies You can define nested locations by specifying a `parent_name` for each row. ION resolves parents automatically, including parents that are created within the same import. Parents are always processed before their children regardless of row order. Circular parent-child relationships are detected and rejected. An example is Location A being the parent of Location B, which is in turn the parent of Location A. > [!NOTE] > > **Can Hold Inventory** and **Pickable** are advisory until an admin turns on the matching enforcement setting in **Settings > Supply Chain > Locations**. With **Enforce can hold inventory** on, a row that turns off `can_hold_inventory` for a location that still holds inventory is rejected. # mBOM imports Source: https://docs.firstresonance.io/administration/ion-importers/mbom-imports Import multi-level bills of materials from a CSV file, using Depth or Level notation to define part hierarchies. ## Overview mBOM imports let you define multi-level part structures in a single CSV, from top-level assemblies down to individual components. ION supports two ways to describe how parts are nested: **Depth** notation and **Level** notation. ION automatically detects which one you are using based on the first column header in your CSV. ## Import options | Option | Default | Description | | - | - | - | | Auto-create missing parts | On | When enabled, any parts in the import that do not already exist in the Parts Library are created automatically. When disabled, referencing a part that does not exist causes a validation error. | | Always create new version | On | When enabled, a new mBOM version is always created. When disabled, the latest version is updated in place if it is a draft; otherwise a new version is created. | ## Columns | Column | Required | Description | | - | - | - | | `depth` or `level` | Yes | The first column in your CSV. Determines how the part hierarchy is structured. See sections below. | | `part_number` | Yes | The part number for this row. | | `revision` | Yes | The part revision. | | `quantity` | Yes | How many of this part are needed in the parent assembly. | | `substitutes` | No | Alternative parts, formatted as `part_number[revision];part_number[revision]`. Example: `BOLT-300-ALT[A];BOLT-300-METRIC[B]`. | | `made_on_assembly` | No | Whether this part is fabricated as part of the parent assembly. Accepts `true`/`false`, `yes`/`no`, `1`/`0`, `y`/`n`, or `t`/`f`, in any case. A blank cell, or a value not in that list, keeps the part's value from the mBOM version the import builds on. A part that wasn't on that version isn't made on assembly. | | `reference_designators` | No | Reference designator strings for the component. For multiple designators, separate each with a semicolon. Example: `J1;J2;J3`. | > [!NOTE] > > Ensure part numbers and revisions match existing records exactly. Part matching is case-insensitive. ## Depth notation Depth notation describes your BOM structure by indenting parts one level at a time, similar to how you might indent items in an outline. The top-level assembly is depth **1**, its direct components are depth **2**, their sub-components are depth **3**, and so on. To move back up the tree and start a new branch, return to a lower depth number. Rows must be listed in the order they appear in the assembly. Each component must come after the assembly it belongs to. **Example:** An assembly (`ASSEMBLY-100`) contains a bracket and a panel. The bracket itself requires four bolts. | depth | part_number | revision | quantity | | - | - | - | - | | 1 | ASSEMBLY-100 | A | 1 | | 2 | BRACKET-200 | B | 2 | | 3 | BOLT-300 | A | 4 | | 2 | PANEL-400 | A | 1 | > [!WARNING] > > You cannot skip depth levels. For example, jumping from depth 1 directly to depth 3 is not allowed. Each component must be listed directly under its parent assembly. ## Level notation Level notation uses a numbering scheme, such as `1`, `1.1`, and `1.1.1`, to explicitly identify where each part sits in the assembly tree. The number itself tells you the full path from the top-level assembly down to the component. Unlike Depth notation, **rows can appear in any order** because the level value fully defines each part's position in the hierarchy. **Example:** The same assembly as above, with rows intentionally listed out of order to show that ordering does not matter. | level | part_number | revision | quantity | | - | - | - | - | | 1 | ASSEMBLY-100 | A | 1 | | 1.2 | PANEL-400 | A | 1 | | 1.1 | BRACKET-200 | B | 2 | | 1.1.1 | BOLT-300 | A | 4 | Here, `1.1` (BRACKET-200) and `1.2` (PANEL-400) are both direct components of `1` (ASSEMBLY-100), and `1.1.1` (BOLT-300) is a sub-component of the bracket, regardless of the row order in the CSV. > [!WARNING] > > Every parent level must exist somewhere in the file. For example, you cannot define `1.1.1` without also having a `1.1` row. Each level value identifies exactly one row. A file in which two rows share a level is rejected, and the error names both rows. > [!TIP] > > Spreadsheet software often rewrites a level of `1.10` as `1.1`, which collides with the row that is already `1.1`. Format the level column as text before you save the file, and check any level ending in a zero. ## Cycle detection ION automatically detects circular references in your mBOM. If assembly A contains part B and part B also contains assembly A (directly or through any chain of intermediate parts), the import fails with a validation error identifying the cycle. This check also applies to substitute parts. # Part inventory imports Source: https://docs.firstresonance.io/administration/ion-importers/part-inventory Create or update part inventory records from a CSV file. ## Overview The Part Inventory importer creates new inventory or updates existing inventory from a single CSV. The distinction is row-by-row: * Rows **without** an `id` value **create** new inventory. `part_number` is required. * Rows **with** an `id` value **update** the matching inventory record. `part_number` and `revision` are optional on these rows and never change the record. If they name a different part or revision than the inventory's current one (ignoring case), the row fails with a row-level error. Creates run through the same path used by the UI, so aBOM creation, serial autogeneration, and tracking-type validation all apply. Updates run through the matching update path, so cascade behavior such as location propagation and quantity validation is preserved. ## Columns | Column | Required | Description | | - | - | - | | `id` | No | Inventory ID. Provide to update an existing record; omit (or leave blank for the row) to create new inventory. **Lookup column**: an empty cell is treated as "not provided," not `0`. | | `part_number` | Yes (for create) | Part number for new inventory. On update rows, optional: if you provide it, it must match the inventory's current part number. | | `revision` | No | Part revision. On create rows, combined with `part_number` to look up the part; if omitted, the latest revision is used. On update rows, optional: if you provide it, it must match the inventory's current revision. A blank revision is not checked. | | `serial_number` | No | Serial number. | | `lot_number` | No | Lot number. | | `quantity` | No | Quantity. Must be non-negative. Empty cells become `0`. | | `quantity_scrapped` | No | Scrapped quantity. Must be non-negative. Empty cells become `0`. | | `location` | No | Location name. Must match an existing location in ION. | | `supplier` | No | Supplier name. Must match an existing supplier in ION. | | `unit_of_measure` | No | Unit of measure name. Must match an existing unit in ION. | | `intent_option` | No | Intent option value. Must match a configured intent option. | | `autogenerate_serial` | No | When `true` on a create row, ION generates a serial number. Cannot be set on update rows. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `autogenerate_lot` | No | When `true` on a create row, ION generates a lot number. Cannot be set on update rows. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | > [!NOTE] > > Name-valued fields (`location`, `supplier`, `unit_of_measure`, `intent_option`) are resolved case-insensitively against existing records. An unrecognized name produces a row-level error. > [!WARNING] > > Setting `autogenerate_serial` or `autogenerate_lot` to `true` on a row that includes an `id` is rejected. Remove the `id` or the flag to fix the row. ## Custom attributes Any column not listed above is treated as a custom attribute on the part inventory. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. # Part-procedure relation imports Source: https://docs.firstresonance.io/administration/ion-importers/part-procedure-relations Link parts to procedures in bulk from a CSV file. ## Overview The Part-Procedure Relations importer links parts to procedures, one CSV row per `(part, procedure)` pair. The part is identified by `part_number` + `revision`, the procedure by `procedure_title` + `procedure_version`, and the only data field is the `required` flag. Re-imports are idempotent: if the link already exists, its `required` flag is updated to match the CSV; otherwise a new link is created. ## Columns | Column | Required | Description | | - | - | - | | `part_number` | Yes | Part number. Matched case-insensitively. | | `revision` | No | Part revision. If omitted and the part has exactly one revision, that revision is used; multiple revisions produce an ambiguity error asking you to specify one. | | `procedure_title` | Yes | Title of the procedure. | | `procedure_version` | Yes | Procedure version. Must be a positive integer. | | `required` | No | Whether the procedure is required for the part. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). Defaults to `false`. | > [!WARNING] > > Each `(part, procedure)` pair can appear only once per file. Duplicate rows are rejected. > > Procedure titles aren't globally unique, so a `(procedure_title, procedure_version)` pair that matches more than one procedure produces an ambiguity error rather than guessing. > [!NOTE] > > This importer does not support custom attributes. Any column outside the list above causes a validation error. # Parts imports Source: https://docs.firstresonance.io/administration/ion-importers/parts Import parts from a CSV file, including revisions, supplier parts, quality clauses, and custom attributes. ## Overview The Parts importer lets you bulk-create or revise parts in a single CSV. It supports the same revision behavior as the UI. A row with an explicit revision creates or updates that exact `(part_number, revision)`. A row that omits the revision creates a new part at the default revision scheme, or revises an existing part and carries over its mBOM and attributes. ## Columns | Column | Required | Description | | - | - | - | | `part_number` | Yes | The part number. | | `revision` | No | The part revision. Omit to let ION assign the next revision automatically (or the scheme's initial value if the part is new). | | `revision_scheme` | No | Name of the revision scheme to use when creating a brand-new part. Defaults to the org's default scheme. The name must match a scheme in your [part revision scheme settings](/administration/supply-chain-settings/configure-part-revision-schemes), and the row's `revision` must follow that scheme's format. | | `description` | No | Free-text description. | | `status` | No | Part status. One of `released` or `archived`. Matched case-insensitively. | | `purchase_type` | No | Purchase type. One of `receivable_inventory`, `receivable_non_inventory`, or `non_receivable_non_inventory`. Matched case-insensitively. | | `tracking_type` | No | Tracking type. One of `serial` or `lot`, matched case-insensitively. Leave the cell blank for an untracked part; `none` is rejected. | | `sourcing_strategy` | No | Sourcing strategy. One of `make`, `buy`, or `dual_source`. Matched case-insensitively. | | `cost` | No | Default unit cost. Empty cells become `0`. | | `lead_time` | No | Lead time as a duration. See [Duration format](#duration-format). | | `reorder_minimum_quantity` | No | Reorder minimum. Must be non-negative. Empty cells become `0`. | | `reorder_maximum_quantity` | No | Reorder maximum. Must be non-negative. Empty cells become `0`. | | `export_controlled` | No | Whether the part is export controlled. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `unit_of_measure` | No | Unit of measure name, such as `each` or `kg`. Must match an existing unit in ION. | | `quality_clauses` | No | Semicolon-delimited list of quality clause reference names to attach to the part. | | `supplier_parts` | No | Semicolon-delimited list of supplier-part records. See [Supplier parts](#supplier-parts) below. | > [!NOTE] > > Part matching is case-insensitive. Enum fields (`status`, `purchase_type`, `tracking_type`, `sourcing_strategy`) only accept the values listed above. An invalid value produces a row-level error listing the allowed options. > > A blank enum cell is not the same as leaving the column out. Omit the column and the field is untouched. Include the column and leave a cell blank, and ION clears the field, which succeeds for `tracking_type` and `sourcing_strategy` (making the part untracked, or clearing its strategy) and fails for `status` and `purchase_type`, which can't be empty. ## Revisions The Parts importer mirrors the UI's revision flow: * **Row with an explicit revision**: looks up `(part_number, revision)`. If it exists, the row updates that part; otherwise it creates a new part at that exact revision. * **Row without a revision, no existing part with that `part_number`**: ION assigns the initial revision from the configured `revision_scheme` (or the org's default scheme, typically `"A"` or `"1"`). * **Row without a revision, existing part with that `part_number`**: ION computes the next revision from the latest existing revision and creates a revised part. The new part inherits the mBOM and extensible attributes of the source part. > [!WARNING] > > You cannot have two rows that both omit `revision` for the same `part_number`. ION cannot disambiguate which one should auto-bump. Specify revisions explicitly to fix the conflict. > > Likewise, an explicit-revision row that collides with an auto-bumped revision from another row is rejected as a duplicate. This happens when one row sets `revision = B` and another auto-bumps to `B`. ## Duration format The `lead_time` column accepts a duration written in days, hours, and minutes. Use the units `d`, `h`, and `m`, in that order, with optional spaces between terms. Each unit is optional. The value is rounded down to the nearest minute. A plain number with no unit is read as a number of seconds. Valid values include: | Value | Meaning | | - | - | | `11d` | 11 days | | `1d 2h` | 1 day, 2 hours | | `10d 21m` | 10 days, 21 minutes | | `45m` | 45 minutes | | `3600` | 3,600 seconds (1 hour) | The **Review** step flags a value that uses any other unit (such as weeks or seconds), lists the units out of order, or is otherwise unparseable. ## Supplier parts The `supplier_parts` column attaches one or more SupplierParts to the part. Use semicolons (`;`) to separate records and pipes (`|`) to separate fields within a record: ``` supplier_name|supplier_part_number|cost|conversion_factor;supplier_name|... ``` | Field | Required | Notes | | - | - | - | | `supplier_name` | Yes | Must match an existing supplier in ION. | | `supplier_part_number` | Yes | The supplier's part number for this part. | | `cost` | No | Falls back to the Part's `cost` if omitted. | | `conversion_factor` | No | Defaults to `1.0`. Must be greater than `0`. | Example: `Acme|ACME-WID-001|4.25|1;Globex|GLX-W1` If a SupplierParts row already exists for the `(part, supplier, supplier_part_number)` combination, the importer updates its `cost` and `conversion_factor` in place. Otherwise it inserts a new row. ## Quality clauses The `quality_clauses` column accepts a semicolon-delimited list of quality clause `reference_name` values. Each must match an existing Requirement with `requirement_type = QUALITY_CLAUSE`. The importer skips associations that already exist, so re-imports are idempotent. Example: `QC-001;QC-002` ## Custom attributes Any column not in the standard list above is treated as a custom attribute on the part. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. Standard column headers are matched case-insensitively, but a custom attribute header must match the attribute's **Name** in your [custom attribute settings](/administration/custom-attributes) exactly, including capitalization and punctuation. For an attribute named `Buyer`, a `buyer` or `BUYER` header fails as an unrecognized column. ION trims spaces around each header before matching it. # Plan input imports Source: https://docs.firstresonance.io/administration/ion-importers/plan-inputs Bulk-add inputs to existing draft plans from a CSV file. ## Overview The Plan Inputs importer adds inputs to **existing draft plans**, one CSV row per input, with the parent plan identified by `plan_id`. A single file can target multiple plans. This importer only creates plan inputs. It never modifies the parent plan itself, and because a plan can legitimately hold multiple inputs for the same part, per-row updates are not supported. To rebuild a plan's inputs, use the **Replace existing inputs** option. ``` plan_id | part_number | revision | quantity | due_date | serial_number 42 | WIDGET-A | A | 10 | 2026-05-01 | 42 | WIDGET-B | A | 5 | 2026-05-01 | 42 | WIDGET-C | B | 1 | 2026-05-01 | SN-12345 ``` ## Import options | Option | Default | Description | | - | - | - | | Replace existing inputs | Off | When enabled, the targeted plans' existing inputs are removed and recreated from the CSV. When disabled, imported inputs are added to the existing ones. | ## Columns | Column | Required | Description | | - | - | - | | `plan_id` | Yes | ID of the parent plan. The plan must exist and be in **draft** status. | | `part_number` | Yes | Part number of the input. Matched case-insensitively. | | `revision` | No | Part revision. If omitted and the part has exactly one revision, that revision is used; multiple revisions produce an ambiguity error asking you to specify one. | | `quantity` | Yes | Input quantity. Must be a non-negative integer. | | `due_date` | Yes | Due date for the input, such as `2026-05-01`. | | `serial_number` | No | Serial number for the input. | | `name` | No | Display name for the input. | | `is_generate_new_demand` | No | Whether the input generates new demand. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `is_independent` | No | Whether the input is independent. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | > [!WARNING] > > Plan inputs can only be added to **draft** plans. Rows referencing a plan in any other status fail with a row-level error, as do rows referencing a plan ID that doesn't exist. > [!NOTE] > > This importer does not support custom attributes. Any column outside the list above causes a validation error. # Purchase order imports Source: https://docs.firstresonance.io/administration/ion-importers/purchase-orders Import purchase orders and their lines from a single denormalized CSV. ## Overview The Purchase Orders importer creates or updates Purchase Orders **and** their Purchase Order Lines from a single CSV. The CSV is denormalized: one row per PO line, with the PO header columns repeated across every row that belongs to the same PO. Example: two POs, three lines. | po_number | supplier | currency | part_number | quantity | cost | | - | - | - | - | - | - | | PO-001 | Acme | USD | WIDGET-A | 10 | 5.00 | | PO-001 | Acme | USD | WIDGET-B | 5 | 12.00 | | PO-002 | Globex | EUR | GADGET-X | 1 | 100.00 | Rows sharing the same `po_number` are merged into a single PO header. If a header column is included in your CSV, it must be populated on **every row of that PO** and all values must match. Any blank cell or any value that disagrees with another row of the same PO fails the import with a per-conflict error before any data is written. ## Header columns These describe the PO itself. If your CSV includes a header column, every row that shares a `po_number` must carry the same value in it, or the import fails. | Column | Required | Description | | - | - | - | | `po_number` | Yes | PO identifier. The grouping key. | | `original_po_number` | No | Existing PO number when renaming. **Lookup column**: an empty cell means "no rename," not `""`. | | `po_description` | No | Free-text PO description. | | `supplier` | No | Supplier name. Must match an existing supplier. | | `ship_to_location` | No | Ship-to location name. Must match an existing location. | | `bill_to_location` | No | Bill-to location name. Must match an existing location. | | `currency` | No | Currency type, such as `USD` or `EUR`. Must match an existing currency. | | `ordered_at` | No | Order date. Parsed flexibly (any pandas-recognized date format). | | `assigned_to` | No | Email of the user the PO is assigned to. Must match an existing user. | | `po_intent_option` | No | Intent option value at the PO level. Prefixed with `po_` to disambiguate from the line-level `intent_option`. | | `po_labels` | No | Semicolon-delimited list of label values to attach to the PO. | | `terms_and_conditions` | No | Title of a Requirement with type `TERMS_AND_CONDITIONS`. Overrides the org's default. | | `fees` | No | Semicolon-delimited list of fee records. See [Fees](#fees) below. | ## Line columns These describe a single PO line. Every row contributes one line if any line column is populated. | Column | Required | Description | | - | - | - | | `part_number` | No | Part number for the line. Combined with `revision` to look up the part. | | `revision` | No | Part revision. If omitted, the latest revision of `part_number` is used. | | `description` | No | Line description. | | `quantity` | No | Line quantity. Must be non-negative. | | `cost` | No | Line unit cost. Must be non-negative. | | `need_date` | No | Date needed. Parsed flexibly. | | `estimated_arrival_date` | No | Estimated arrival date. Parsed flexibly. | | `original_estimated_arrival_date` | No | The supplier's first promised arrival date, kept as a baseline so you can measure slip after the estimated arrival date is revised. Parsed flexibly. Nothing fills it in for you, and a copied line doesn't inherit it. | | `paid` | No | Marks the line as paid. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `percentage_fee_exempt` | No | Excludes this line from percentage-based PO fees. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `labels` | No | Semicolon-delimited list of label values to attach to the line. | | `quality_clauses` | No | Semicolon-delimited list of quality clause titles. Must match Requirements with `requirement_type = QUALITY_CLAUSE`. | | `intent_option` | No | Intent option value at the line level. | > [!NOTE] > > A row that populates only header columns (no `part_number` or other line column) contributes to the PO header but does not create a line. Use this to create or update a PO without lines. > [!NOTE] > > The importer doesn't set a line's **Project** or **Charge Account**. Set them on the line after the import. See [Edit purchase order lines](/manage-supply-chain/purchasing/create-a-purchase-order#edit-purchase-order-lines). ## Fees The `fees` column accepts a semicolon-delimited list of fee records. Each record uses two bracketed fields after the fee name: ``` Name[value][type];Name[value][type] ``` | Field | Notes | | - | - | | `Name` | Required. Must be unique within the PO. | | `value` | Required. Must parse as a number. | | `type` | Required. One of `currency` or `percentage`. | Example: `Shipping[50.00][currency];VAT[8.5][percentage]` > [!WARNING] > > Fee names must be unique within a PO. Duplicate fee names in the same row's `fees` cell are rejected at validation. ## Custom attributes Any column not in the standard set above is treated as a custom attribute. The importer routes each column to either PO-level or PO-line-level attributes based on which table defines it in your organization's attribute configuration: * A column matching a PO custom attribute is attached to the PO. * A column matching a PO-line custom attribute is attached to the line. * A column matching **both** is **ambiguous** and rejected. Rename one side to disambiguate. * A column matching neither is rejected as unrecognized. Matching is case- and format-sensitive, so a CSV header `BatchID` matches an attribute keyed `BatchID` only. ## Header conflicts Header-column conflicts are collected across all POs and reported together, so you can fix everything in one pass. # Run imports Source: https://docs.firstresonance.io/administration/ion-importers/runs Bulk-create runs from a CSV file, including procedures, part inventory, assignees, and run batches. ## Overview The Runs importer bulk-creates runs, one CSV row per run. It drives the same path as creating runs in the UI, so step copying, batching, and every downstream side effect behave identically. This importer is **create-only**: it does not update existing runs. Each run can: * be created from a **procedure**, identified by `procedure_id` *or* `procedure_title` + `procedure_version` (a run with no procedure is also allowed, unless your org turns on [Require a procedure on every run](/administration/production-settings/configure-run-enforcement)), * be tied to **part inventory**, either linking an existing record via `part_inventory_id` or creating a new one via `part_number`, * join a **run batch** via `run_batch_title`, * carry an assignee, intent option, due date, and custom attributes. ## Columns | Column | Required | Description | | - | - | - | | `title` | Conditional | Run title. Each row needs either a `title` or `autogenerate_title = true`, but not both. | | `autogenerate_title` | Conditional | When `true`, ION generates the run title. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `procedure_id` | No | ID of the procedure to create the run from. Cannot be combined with `procedure_title` / `procedure_version`. | | `procedure_title` | No | Procedure title. Must be paired with `procedure_version`. | | `procedure_version` | No | Procedure version (integer). Must be paired with `procedure_title`. | | `description` | No | Free-text description. | | `due_date` | No | Due date, such as `2026-06-15`. An empty cell leaves the field unset. | | `quantity` | No | Run quantity. Must be a non-negative integer. When the row creates a new inventory via `part_number`, the quantity applies to that inventory. An empty cell leaves the field unset. | | `part_number` | No | Part number. Creates a **new** inventory record for the run. Cannot be combined with `part_inventory_id`. | | `revision` | No | Part revision for the new inventory. If omitted and the part has exactly one revision, that revision is used. | | `serial_number` | No | Serial number for the new inventory. | | `lot_number` | No | Lot number for the new inventory. | | `autogenerate_serial_number` | No | When `true`, ION generates a serial number for the new inventory. Boolean field. | | `autogenerate_lot_number` | No | When `true`, ION generates a lot number for the new inventory. Boolean field. | | `part_inventory_id` | No | ID of an **existing** inventory record to link to the run. Cannot be combined with `part_number` or any of the new-inventory columns above. | | `assigned_to` | No | Email address of the user to assign. An empty cell leaves the run unassigned. | | `intent_option` | No | Intent option name. Must match a configured intent option. | | `export_controlled` | No | Whether the run is export controlled. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `run_batch_title` | No | Title of the run batch to add the run to. See [Run batches](#run-batches). | > [!WARNING] > > Three column groups are mutually exclusive per row: > > * `title` vs. `autogenerate_title`: provide exactly one. > * `procedure_id` vs. `procedure_title` + `procedure_version`: provide at most one form. > * `part_inventory_id` vs. `part_number`: when linking an existing inventory, the new-inventory columns (`revision`, `serial_number`, `lot_number`, `autogenerate_serial_number`, `autogenerate_lot_number`) must be empty. > [!NOTE] > > Procedure titles aren't globally unique, so a `(procedure_title, procedure_version)` pair that matches more than one procedure produces an ambiguity error. Use `procedure_id` to disambiguate. ## Run batches Rows sharing a `run_batch_title` are grouped into a single run batch. Batch titles are unique in ION, so this is a find-or-create: if a batch with that title already exists, the runs join it; otherwise ION creates the batch. ## Custom attributes Any column not in the standard list above is treated as a custom attribute on the run. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. # Supplier imports Source: https://docs.firstresonance.io/administration/ion-importers/suppliers Create or update suppliers from a CSV file, including contact details and custom attributes. ## Overview The Suppliers importer bulk-creates or updates suppliers from a single CSV. Matching is **case-insensitive on `name`**. Rows whose name matches an existing supplier update that supplier, and rows with a new name create one. ## Columns | Column | Required | Description | | - | - | - | | `name` | Yes | The supplier name. Matched case-insensitively against existing suppliers. | | `description` | No | Free-text description. | | `phone_number` | No | Contact phone number. | | `address` | No | Supplier address. | | `email` | No | Contact email address. | | `contact_name` | No | Name of the primary contact. | > [!WARNING] > > Each supplier name may appear only once per file. Two rows with the same name (compared case-insensitively) produce a duplicate-name validation error. ## Custom attributes Any column not in the standard list above is treated as a custom attribute on the supplier. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. # Tool inventory imports Source: https://docs.firstresonance.io/administration/ion-importers/tool-inventory Create or update tool inventory records from a CSV file, including maintenance dates and asset URIs. ## Overview The Tool Inventory importer creates or updates inventory records for tools (parts with the **tool** part type). It works like the [Part Inventory importer](/administration/ion-importers/part-inventory), where rows without an `id` create new inventory and rows with an `id` update the matching record, with two tool-specific additions: `last_maintained_date` and `uri`. Because tools are always serial-tracked, **every create row must provide a `serial_number`** matching the physical asset's tag or manufacturer serial. There is no serial autogeneration and no lot tracking for tool inventory. ## Columns | Column | Required | Description | | - | - | - | | `id` | No | Inventory ID. Provide to update an existing record; omit to create new inventory. **Lookup column**: an empty cell is treated as "not provided," not `0`. | | `part_number` | Yes (for create) | Part number of the tool. Ignored on update. | | `revision` | No | Tool revision. Combined with `part_number` to look up the tool; if omitted, the latest revision is used. | | `serial_number` | Yes (for create) | Serial number identifying the physical tool. Update rows inherit the existing serial. | | `location` | No | Location name. Must match an existing location in ION. | | `last_maintained_date` | No | Date the tool was last maintained, in ISO 8601 format, such as `2026-05-01` or `2026-05-01T12:30:00`. An empty cell leaves the field unset. | | `uri` | No | Link to the physical asset, such as an asset-management URL. Must be unique across tool inventory; an empty cell stores no value. | > [!NOTE] > > `last_maintained_date` only accepts ISO 8601. Ambiguous formats like `1/2/3` are rejected rather than guessed. ## Custom attributes Any column not in the standard list above is treated as a custom attribute on the inventory record. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. # Tools imports Source: https://docs.firstresonance.io/administration/ion-importers/tools Create or revise tools from a CSV file, including subtypes and maintenance intervals. ## Overview The Tools importer bulk-creates or revises tools. In ION, a tool is a part with the **tool** part type, so this importer follows the same revision flow as the [Parts importer](/administration/ion-importers/parts) but exposes a narrower, tool-relevant column set. Two things are set automatically on every row: * **Part type** is always `tool`. * **Tracking type** is always `serial`, because tools are serial-tracked. Including a `tracking_type` column in the CSV is rejected. ## Columns | Column | Required | Description | | - | - | - | | `part_number` | Yes | The tool's part number. | | `revision` | No | The revision. Omit to let ION assign the next revision automatically (or the scheme's initial value if the tool is new). | | `revision_scheme` | No | Name of the revision scheme to use when creating a brand-new tool. Defaults to the org's default scheme. | | `description` | No | Free-text description. | | `export_controlled` | No | Whether the tool is export controlled. Boolean field (see [accepted values](/administration/ion-importers#accepted-boolean-values)). | | `maintenance_interval` | No | Maintenance interval as a duration. See [Duration format](#duration-format). | | `subtypes` | No | Semicolon-delimited list of tool subtype names, such as `Torque Wrench;Calibrated`. | ## Duration format The `maintenance_interval` column accepts a duration written in days, hours, and minutes. Use the units `d`, `h`, and `m`, in that order, with optional spaces between terms. Each unit is optional. The value is rounded down to the nearest minute. A plain number with no unit is read as a number of seconds. Valid values include: | Value | Meaning | | - | - | | `30d` | 30 days | | `1d 2h` | 1 day, 2 hours | | `1d 2h 20m` | 1 day, 2 hours, 20 minutes | | `45m` | 45 minutes | | `3600` | 3,600 seconds (1 hour) | The **Review** step flags a value that uses any other unit (such as weeks or seconds), lists the units out of order, or is otherwise unparseable. ## Revisions Revision behavior mirrors the [Parts importer](/administration/ion-importers/parts#revisions): rows with an explicit revision create or update that exact `(part_number, revision)`, while rows that omit revision either initialize a new tool at the scheme's first value or auto-revise an existing tool from its latest revision. ## Subtypes The `subtypes` column attaches one or more subtypes to the tool. Subtype names are matched case-insensitively; **names that don't exist yet are created automatically**, so you can bootstrap your subtype list from the same CSV. Associations that already exist are skipped, keeping re-imports idempotent. A row that auto-revises an existing tool copies the subtypes of the revision it revises onto the new revision. ## Custom attributes Any column not in the standard list above is treated as a custom attribute on the tool. Custom attribute columns must match a configured attribute key for your organization; unknown columns cause a validation error. # Labels Source: https://docs.firstresonance.io/administration/labels Create and delete the shared labels used to tag and group procedures, runs, purchases, issues, and other records across ION. **Labels** are shared tags you apply across ION to group related records. The same label library is shared by every object type, so a single label can tie together procedures, runs, purchases, and issues. ## Create a label You create labels inline from any record that supports them, such as a procedure, run, purchase, or issue: 1. On the record, click **Labels** (or **Add labels**). 2. In the picker, type the label name in the **Search or create labels...** box. 3. If no matching label exists, click **Create ""**. ION creates the label and applies it to the current record. To reuse it elsewhere, open the labels picker on another record and search for it. ## Delete a label Deleting a label removes it from all records across ION. Label deletion is only available through the API; there is no UI option yet. 1. Query for the label to get its `id` and `_etag`. Replace `` with the label value. ```graphql theme={null} { labels(filters: {value: {eq: }}) { edges { node { id _etag value } } } } ``` 2. Delete the label using the `id` and `_etag` from the previous query. ```graphql theme={null} mutation DeleteLabel($id: ID!, $etag: String!) { deleteLabel(id: $id, etag: $etag) { id } } ``` Variables: ```json theme={null} { "id": "", "etag": "" } ``` # Configure barcode labels Source: https://docs.firstresonance.io/administration/organization-settings/configure-barcode-labels Customize barcode label templates for inventory, kits, and locations in ION. ION can print barcode labels for inventory items, kits, locations, and runs. Each entity type can have multiple named label templates, and you can optionally connect a dedicated print server. ## Create a label template 1. In ION, go to **Settings > Organization > Barcode Labels**. 2. In the **Label templates** section, select the tab for the entity type you want to configure: **Inventory**, **Kits**, **Locations**, or **Runs**. 3. Click **New Template**. 4. Fill in the template fields: | Field | Description | | - | - | | **Template Name** | A name to identify this template. | | **Print density (DPI)** | Printer DPI setting. Default is 203. Match this to your printer's DPI. | | **Label height (inches)** | Height of the label in inches. Default is 1. | | **Label width (inches)** | Width of the label in inches. Default is 3. | | **ZPL Template** | The label layout written in ZPL (Zebra Programming Language). | 5. Click **Create Template**. ![Barcode Labels settings showing the Inventory/Kits/Locations/Runs tabs, a templates list, a ZPL template with variable placeholders, an Available Fields panel, and Template Settings for name, print density, and label size.](https://mintcdn.com/firstresonance/Sz_vZtaxyNMzjHVb/images/administration/barcode-label-editor.png?fit=max\&auto=format\&n=Sz_vZtaxyNMzjHVb\&q=85\&s=bb4aec9447b2810e9bf364f13e548453) The Barcode Labels editor with a ZPL template, its available fields, and the template settings. ## Edit a label template 1. In ION, go to **Settings > Organization > Barcode Labels**. 2. Select the tab for the entity type, then select the template you want to edit from the **Templates** list. 3. Update the template fields. 4. Click **Save Template**. To remove a template, select it, then click **Deactivate**. ### Available template variables Insert variables into your ZPL template, and ION replaces them with the record's data when it prints. A variable is a field of the record in camelCase, such as `${serialNumber}`. A field of a related record is nested under that record, such as `${part.partNumber}`. The **Available Fields** panel in the template editor lists every variable for the template's entity type. Common variables on an inventory template: | Variable | Value | | - | - | | `${iuid}` | The ION barcode ID. Encode it in the QR code so ION can scan the label. | | `${part.partNumber}` | Part number | | `${part.revision}` | Part revision | | `${part.description}` | Part description | | `${serialNumber}` | Serial number | | `${lotNumber}` | Lot number | | `${quantity}` | Quantity | | `${location.name}` | Location name | | `${activeKitId}` | Active kit ID | ## Set the default print order When an operator prints labels for several records at once, this setting decides which label comes off the printer first. 1. In ION, go to **Settings > Organization > Barcode Labels**. 2. In the **Print order** section, set **Default order for bulk prints** to **As listed** or **Reversed**. **As listed** prints the records in the order they're listed, which for a table is its current sort, and **Reversed** prints them back to front. The default applies to every printer, not only the print server. An operator can override it for a single print from the **Print Order** control, without changing the default. See [Print a label](/build-hardware/labels-and-scanning/printing#choose-the-print-order). ![Print order settings section with Default order for bulk prints set to As listed and the description: Applies to every printer. An operator can override it for a single print.](https://mintcdn.com/firstresonance/LcoLWSflonfLADAD/images/administration/barcode-settings-print-order.png?fit=max\&auto=format\&n=LcoLWSflonfLADAD\&q=85\&s=3e3229d3b7112426ad0cdbfadc3c5faa) The Print order section of the Barcode Labels settings. ## Connect a print server A print server lets ION send barcode labels directly to a printer without requiring a browser print dialog. 1. In ION, go to **Settings > Organization > Barcode Labels**. 2. Turn on **Use print server**. 3. In the **Print server API key** field, enter the API key for your print server. To view the existing API key, click **Show**. You need admin access to reveal the key. # Configure export control Source: https://docs.firstresonance.io/administration/organization-settings/configure-export-control Configure identity groups and understand how ION restricts export-controlled parts, procedures, and runs. Export control adds a group-based access decision on top of ION's standard roles and permissions. A person needs an allowed identity-provider group to reach export-controlled parts, procedures, and runs. Their normal ION permissions still determine which actions they can perform on the records they can reach. ```mermaid theme={null} flowchart LR subgraph config["1. Configure in your identity provider"] G["Add people to the
Export UnRestricted group"] end subgraph signin["2. At each sign-in"] S["SSO sends the person's
group membership to ION"] end subgraph records["3. Records in ION"] R["Parts, procedures, and runs
marked export controlled"] end subgraph access["4. What each person can access"] U["Export-unrestricted
Every record, including
controlled parts, procedures, and runs"] X["Export-restricted
Controlled records are hidden from lists;
a direct link returns not found"] end G --> S --> D{"In an allowed
export group?"} R --> D D -- "Yes" --> U D -- "No or missing" --> X ``` ## How ION decides access During sign-in, ION reads the group memberships your identity provider sends through its standard group data. For each request, ION checks that membership for an exact match with either of these group names: * `Employee Export UnRestricted` * `Export UnRestricted` If either name is present, the person is export-unrestricted for that session. A missing group, an empty group list, or any other group name keeps the person export-restricted. ION compares group names, so your identity provider must send each group by its name. A group sent by its ID never matches. > [!NOTE] > > The export-control decision reads your identity provider's group membership, not an arbitrary SSO attribute. If your identity provider stores the entitlement in another attribute, map that value into the group data your SSO connection sends before ION can act on it. ## What export control protects Export control applies to three record types: parts, procedures, and runs. For an export-restricted person, a flagged record is omitted from query results, and a direct link returns not found. A run is treated as export-controlled when its own flag, its associated part, or its source procedure is export-controlled. ION doesn't manage export-control group membership. You manage it in your identity provider. Because ION filters these records before an update can load them, an export-restricted person can't edit an existing export-controlled part, procedure, or run. They also can't mark a part, procedure, or run as export-controlled. > [!WARNING] > > Export-control filtering covers parts, procedures, and runs. Related records keep their own access behavior. Part inventory records aren't filtered, but an export-restricted person can't update inventory tied to an export-controlled part. ## Configure export-control access 1. Contact [First Resonance Support](https://support.firstresonance.io/) to enable export control and confirm that your SSO connection sends identity-provider group membership to ION. 2. In your identity provider, create or identify a group named exactly `Employee Export UnRestricted` or `Export UnRestricted`. Configure your SSO connection to send group names in its group data. For Microsoft Entra ID, see the Entra notes in [Set up SSO](/administration/authentication-settings/sso/set-up-sso). 3. Add each person who can access export-controlled records to one of the allowed groups. Keep everyone else out of both groups. 4. After you change group membership, have the affected person start a new sign-in session so ION receives their current groups. ## Mark a record as export-controlled An export-unrestricted person sets the flag on the record itself: * On a procedure, turn on the **Export control** toggle. * While creating a run, turn on **Export controlled**. * On a part, set the `export_controlled` column to `true` when you [import parts](/administration/ion-importers/parts). ## Verify the restriction 1. Prepare a controlled test record: * On a test procedure, turn on **Export control**, then create a run from that procedure. * To test a part, [import a test part](/administration/ion-importers/parts) with `export_controlled` set to `true`, then associate it with a run. * To test a run on its own, turn on **Export controlled** while creating the run. 2. Sign in with an account in one of the allowed groups that also has the ION permissions the records need. Confirm that the part or procedure and its associated run are available. 3. Sign in with an account outside both allowed groups. Confirm that list results omit the controlled records and that a direct link returns not found. 4. If the part has inventory, confirm that the inventory record stays visible but an update to it is blocked. ## Troubleshooting > [accordion] User must be Employee Export UnRestricted error > > **Cause:** At the person's last sign-in, ION didn't receive either allowed group name. The group might be missing from the group data your identity provider sends, or it arrived as a group ID instead of the group's name. > > **Fix:** Confirm that the person belongs to `Employee Export UnRestricted` or `Export UnRestricted`, and that your SSO connection sends group names. Then have the person start a new sign-in session. # Configure general settings Source: https://docs.firstresonance.io/administration/organization-settings/configure-general-settings Update your organization's name and logo in ION. General settings control how your organization appears: the name shown across the app, and the logo displayed in the interface and on a printed [purchase order](/manage-supply-chain/purchasing/create-a-purchase-order). ## Set the organization name 1. In ION, go to **Settings > Organization > General Settings**. 2. In the **Organization Name** field, type the new name. The name can be left empty. While the field is empty, ION shows your organization's domain in place of the name. ## Update the organization logo 1. In ION, go to **Settings > Organization > General Settings**. 2. In the **Branding** section, click **Change Image**. 3. In the **Upload Photo URL** dialog, enter a publicly accessible URL in the **Image URL** field. 4. Click **Save**. To remove the current logo, click **Change Image**, then click **Remove**. Until you set one, a printed purchase order carries your organization's name alone and its **Company Logo** option is unavailable. # Configure ION Intelligence Source: https://docs.firstresonance.io/administration/organization-settings/configure-ion-intelligence Accept the AI Terms of Service, opt your organization in to ION Intelligence, and choose the model it uses. ION Intelligence is off until an admin turns it on. The setting is org-wide, so while it is off nobody in the organization can reach an ION Intelligence surface, admins included. Turning it on takes two things: an admin accepts the **AI Terms of Service** on behalf of the organization, and the switch is set. ION serves the terms from the backend, so the text an admin reads and the version recorded against their acceptance cannot drift apart. ## Turn on ION Intelligence 1. In ION, go to **Settings > Organization > ION Intelligence**. 2. Under **Availability**, turn on **Enable ION Intelligence**. The **AI Terms of Service** dialog opens with the terms in force for your region. 3. Read the terms, then select **I have read these terms and accept them on behalf of my organization.** 4. Click **Accept and enable**. ION records the acceptance and turns ION Intelligence on in one step. **Cancel** closes the dialog and leaves the switch off. Only an admin can change the setting. Everyone else sees **Only an admin can change this.** in place of the help text. Once consent is recorded, the section reads **AI Terms of Service accepted on ``.** beneath the switch. > [!NOTE] > > Consent covers one activation. Turning ION Intelligence off ends the acceptance that authorized > it, so turning it back on opens the terms again. Publishing a new version of the terms has the > same effect. The **AI Terms of Service accepted on** line is withheld whenever a fresh acceptance > is due, so it never claims consent that no longer stands. Turning ION Intelligence **off** is never gated on consent, so an admin can always withdraw. Every acceptance is kept as an append-only record of who accepted, when, and exactly which text they were shown. ## Choose the model An admin picks the model ION Intelligence uses for everyone in the organization. The **Model** section appears once ION Intelligence is on. 1. In ION, go to **Settings > Organization > ION Intelligence**. 2. Under **Model**, pick a model from the list. The list shows the models available to your organization, and marks the default **(Default)**. 3. Click **Save**, then click **Switch model** to confirm. Every chat in the organization uses the new model from its next message on. Only an admin can change the model. If the model your organization picked is no longer available, ION Intelligence uses the default. ## What the setting governs > [!WARNING] > > Turning it off disables ION Intelligence immediately for all users in your organization. It does > not affect the ION MCP connector or the ION API. Data a user can reach with their own > credentials remains reachable through those, including by AI tools they connect themselves. The help text beside the switch changes with the switch's position: it reads **ION Intelligence is off until you turn it on** while off, and **ION Intelligence is on, and available to everyone in this organization** while on. ## When the switch won't turn on If ION Intelligence is not available to your organization, the **Availability** section reads **ION Intelligence is not available for this organization. Contact your First Resonance representative to enable it.** in place of the switch. If ION cannot check whether the terms need accepting, the switch is held off and the section reads **Couldn't check whether the AI Terms of Service need to be accepted, so ION Intelligence can't be turned on right now.** with a **Try again** control beside it. Only the enable direction is held, so an admin can still turn ION Intelligence off. # Manage OAuth apps Source: https://docs.firstresonance.io/administration/organization-settings/manage-oauth-apps Register a custom application to authenticate with the ION API using OAuth 2.0. OAuth applications let your custom tools and integrations authenticate with the ION API. ION supports two app types: web and desktop apps, which use the PKCE flow, and IoT or limited-input devices, which use the Device Authorization Grant. ## Register an app 1. In ION, go to **Settings > Organization > OAuth Apps**. 2. Click **Register App**. 3. Enter an **Application Name**. 4. Select the application type: * **Web / Desktop App (PKCE)**: For web or desktop applications using the Authorization Code + PKCE flow. * **Device / Wearable**: For IoT devices or limited-input devices using the Device Authorization Grant. 5. Click **Register**. Copy the **Client ID** from the app's entry for use in your application. ## Add redirect URIs (web / desktop apps only) After registering a web or desktop app, add the URIs your application uses: 1. In the app's entry, click **Add Callback URL** and enter your callback URL (for example, `https://your-app.com/callback`). 2. Optional: Add any of the following: * Click **Add Origin** to add an allowed CORS origin. * Click **Add Logout URL** to add a post-logout redirect URL. To remove a URL, click the **X** next to it. > [!NOTE] > > An app's name and type are fixed after registration. To change them, delete the app and register a new one. ## Delete an app 1. In ION, go to **Settings > Organization > OAuth Apps**. 2. In the app's entry, click the delete icon. 3. Confirm the deletion. > [!WARNING] > > Deleting an OAuth app revokes access for all applications using that client ID. This cannot be undone. # Set the date format Source: https://docs.firstresonance.io/administration/organization-settings/set-the-date-format Choose how dates are displayed across your ION organization. The date format setting controls how dates appear throughout ION for all users in your org. ## Set the date format 1. In ION, go to **Settings > Organization > Date Time**. 2. In the **Date Format** field, either: * Type a custom format string (for example, `YYYY-MM-DD`). * Open the dropdown to select a predefined format. 3. Check the **Preview** section to confirm today's date appears in the selected format. ## Predefined formats | Format | Example | | - | - | | `YYYY-MM-DD` | 2026-06-11 | | `MM/DD/YYYY` | 06/11/2026 | | `DD/MM/YYYY` | 11/06/2026 | | `DD/MMM/YYYY` | 11/Jun/2026 | | `DD-MMM-YYYY` | 11-Jun-2026 | # Auto-assign runs to their creator Source: https://docs.firstresonance.io/administration/production-settings/auto-assign-runs-to-their-creator Assign every new run to the person who created it, unless they pick a different assignee. By default a new run is unassigned until someone picks it up. When this setting is on, a run is assigned to whoever created it unless an assignee is chosen at creation. ## Auto-assign runs to their creator 1. In ION, go to **Settings > Production > Runs**. 2. Turn on **Auto-assign runs to their creator**. ## What changes for the person creating a run While the setting is on, the run creation form pre-fills **Assigned to** with you. If you clear the field, ION still assigns the run to you. # Configure procedure reviewer roles Source: https://docs.firstresonance.io/administration/production-settings/configure-procedure-reviewer-roles Set which roles must approve a procedure before it can be released, and whether its creator can approve it. Reviewer roles define which roles must sign off on a procedure before it reaches the Released state. Each role has a minimum number of approvals required. **Settings > Production > Procedures** shows the controls for the approval model your org is on. An org on role-based approvals gets the **Reviewer roles** editor described here. An org on the reviewer-count model gets a single **Reviewers required** field instead. See [Set the number of reviewers required](#set-the-number-of-reviewers-required). > [!NOTE] > > Which model your org uses isn't something you set on this page. To change it, contact [support.firstresonance.io](https://support.firstresonance.io). ## Add a reviewer role 1. In ION, go to **Settings > Production > Procedures**. 2. In the **Reviewer roles** section, click **Add role**. 3. Select the role from the dropdown. 4. Set the number of approvals required for that role. 5. Click **Save Changes**. ## Update the approver count 1. In the **Reviewer roles** section, find the role you want to update. 2. In the count field beside the role, enter the number of approvals required. 3. Click **Save Changes**. ## Remove a reviewer role 1. In the **Reviewer roles** section, click **X** next to the role you want to remove. 2. Click **Save Changes**. ## Prevent creators from approving their own procedures On role-based approvals, you can stop a procedure's creator from reviewing their own work. With the setting on, the creator can still be added to the procedure's reviewers, but ION blocks them when they try to approve it, even through a role or team they belong to. The setting is off by default, and it doesn't appear on the reviewer-count model. 1. In ION, go to **Settings > Production > Procedures**. 2. Turn on **Prevent creators from approving their own procedures**. ## Set the number of reviewers required On the reviewer-count model, a procedure needs a set number of approvals to be released, from any reviewer, with no per-role breakdown. 1. In ION, go to **Settings > Production > Procedures**. 2. In **Reviewers required**, enter the number of approvals a procedure needs. The value saves automatically. Enter 0 to release a procedure without approvals. Clearing the field doesn't save an empty value, so the previous number stays until you type a new one. # Configure run enforcement Source: https://docs.firstresonance.io/administration/production-settings/configure-run-enforcement Set which rules ION enforces when runs are in progress or completing. ## Configure run enforcement 1. In ION, go to **Settings > Production > Runs**. 2. Turn on or off the settings you need: | Setting | What it does | | - | - | | **Require part-procedure relationship** | Parts must be linked to procedures before they can be used in runs. | | **Require a procedure on every run** | Runs can't be created without a procedure, including from the runs importer. A procedure can't be linked to a run after the run exists. | | **Allow run steps to complete without required install** | Steps can be marked complete even if required parts haven't been installed. | | **Enforce peer signoff** | A different user must sign off on each step completion. | | **Enforce run title template** | Run titles must follow the configured naming template. | | **Enforce all aBOM parts installed for completion** | Runs can't be completed if any aBOM parts remain uninstalled. | | **Require issues resolved before run completion** | Runs can't be completed while any of their steps have unresolved issues. | | **Require a location on the output unit before run completion** | Build and maintenance runs that produce a unit can't be completed until that unit has a location set. | When **Enforce all aBOM parts installed for completion** is on, you can also turn on **Allow completion with justification** to complete runs with uninstalled parts by providing a written justification. The last three settings above all gate run *completion*, so an operator meets them at the end of a run rather than while working it. **Require a location on the output unit before run completion** applies only to runs that produce a unit; a run with no output unit is unaffected. The **Number of redline approvers required** field on the same page sets how many approvals a redline needs. See [Set the redline approver count](/administration/production-settings/set-redline-approver-count). ## Set the run title template The run title template names new runs automatically. Set it before turning on **Enforce run title template**, which stays disabled until a valid template is saved. 1. In ION, go to **Settings > Production > Runs**. 2. In **Run title template**, enter the pattern to apply to new run titles, for example `${id}-${partNumber}-${partRevision}`. 3. Include `${id}` (required), plus any of these tokens: `${partNumber}`, `${partRevision}`, `${partDescription}`, `${procedureTitle}`, `${procedureVersion}`, `${serialNumber}`, `${lotNumber}`, `${quantity}`, and `${dueDate}`. Text outside the tokens is kept as written. ION flags a template that omits `${id}` or uses an unknown token. # Configure standard step reviewer roles Source: https://docs.firstresonance.io/administration/production-settings/configure-standard-step-reviewer-roles Set which roles must approve a standard step before it can be released. Reviewer roles define which roles must sign off on a standard step before it reaches the Released state. ## Add a reviewer role 1. In ION, go to **Settings > Production > Standard Steps**. 2. In the **Reviewer roles** section, click **Add role**. 3. Select the role from the dropdown. 4. Set the number of approvals required for that role. 5. Click **Save Changes**. ## Update the approver count 1. In the **Reviewer roles** section, find the role you want to update. 2. In the count field beside the role, enter the number of approvals required. 3. Click **Save Changes**. ## Remove a reviewer role 1. In the **Reviewer roles** section, click **X** next to the role you want to remove. 2. Click **Save Changes**. # Enable mBOM version selection Source: https://docs.firstresonance.io/administration/production-settings/enable-mbom-version-selection Let a procedure pin the mBOM version it assigns from, and require a pin before a part can be assigned to steps. This setting decides whether the mBOM version pinned to a part governs the procedure that assigns from it. It's independent of [Enforce mBOM parts assigned to steps](/administration/production-settings/enforce-mbom-parts-assigned-to-steps), so you can turn either one on without the other. ## Enable mBOM version selection 1. In ION, go to **Settings > Production > Procedures**. 2. Turn on **Enable mBOM version selection**. Turning the setting on re-pins every procedure, released ones included, to each part's latest released mBOM version, replacing any pin set earlier. A part with no released version is left unpinned until you release one and pin it. ## What the setting changes With the setting on: * A part with no pin uses its latest released mBOM version. Review and release are blocked only by a pin to a version that's no longer released, by assignments from another unreleased version, or by over-assigned quantity. See [Create and release a procedure](/build-hardware/procedures/create-and-release-a-procedure#submit-for-review-and-approve). * New runs follow the pinned version instead of the latest released one. * A part can be assigned to steps only from the version pinned to the procedure. ION refuses an assignment while the part has no pin, or from any other version. * The **mBOM** row in the procedure's **Assigned Parts** section carries the version picker and the pin controls. See [Switch the pinned mBOM version](/build-hardware/procedures/installation-requirements-beta#switch-the-pinned-mbom-version). * Creating a new mBOM revision stops copying part-step assignments onto the new revision for procedures that pin the part, because a new revision is born in draft and an assignment on it would be unreachable. * Assigning a sub-assembly's components needs that sub-assembly's own pin first, which you set when you assign the sub-assembly in the procedure's right rail. With the setting off, a pin recorded on a part is ignored, on released procedures as well as drafts, and the part's latest released mBOM version governs, so assignments carry forward to a new revision as before. > [!NOTE] > > With the setting on, a draft mBOM version never governs. A part whose only version is unreleased has no governing version, so there is nothing to assign from until you release a version. With the setting off, the part's latest **Draft** or **In Review** version governs assigning parts to steps. See [Which mBOM version governs](/build-hardware/procedures/installation-requirements-beta#which-mbom-version-governs). # Enforce mBOM parts assigned to steps Source: https://docs.firstresonance.io/administration/production-settings/enforce-mbom-parts-assigned-to-steps Require every mBOM part to be assigned to a step before a procedure can be sent for review or released. This setting makes step assignment a condition of moving a procedure forward, and it keeps part quantities in sync with the assignments. Which mBOM version those assignments come from is a separate setting; see [Enable mBOM version selection](/administration/production-settings/enable-mbom-version-selection). ## Enforce mBOM parts assigned to steps 1. In ION, go to **Settings > Production > Procedures**. 2. Turn on **Enforce mBOM parts assigned to steps**. ## What the setting changes With the setting on: * Every part must be assigned to a step before a procedure can be sent for review or released. * Once all of an assembly's parts are assigned to steps, part quantities stay in sync with the assignments: editing a step's assignment updates the run quantity automatically. The gate applies to both forward transitions: **Draft** to **In Review**, and **In Review** to **Released**. It covers the procedure's own mBOM lines and the components inside its sub-assemblies, at any depth. When a part is unassigned, the transition is blocked and lists the unassigned parts. > [!NOTE] > > When ION can't check the whole sub-assembly tree, it says that some components were not checked and asks you to check them before releasing, without blocking the transition. That covers a sub-assembly level holding more items than can be checked at once, and a tree nested deep enough that the check stops early. A failed data load is different: it does block, because a reload clears it. # Require barcode scanning for installations Source: https://docs.firstresonance.io/administration/production-settings/require-barcode-scanning-for-installations Require barcode scanning when you install inventory on an aBOM. When this setting is on, you can't pick inventory to install on a run's aBOM. Install it by scanning a barcode, or from a kit. On a batched run, parts that aren't serial-tracked can be installed only from a kit or by someone with the bypass role. You can designate one role that can bypass the restriction. ## Require barcode scanning for installations 1. In ION, go to **Settings > Production > aBOMs**. 2. Turn on **Disable manual inventory installations**. 3. Optional: In the **Role allowed to bypass install restrictions** field, select the role that can still install inventory manually. To install by scanning, see [Install inventory on a run](/build-hardware/labels-and-scanning/scanning/scan-with-a-handheld-scanner#install-inventory-on-a-run) for a handheld scanner, or [Scan on a run, the kitting page, or a pick run](/build-hardware/labels-and-scanning/scanning/scan-with-a-camera#scan-on-a-run-the-kitting-page-or-a-pick-run) for the camera. # Set the redline approver count Source: https://docs.firstresonance.io/administration/production-settings/set-redline-approver-count Set how many approvals are required before a redline is applied in ION. The redline approver count controls how many users must approve a redline before it is applied to a procedure. ## Set the redline approver count 1. In ION, go to **Settings > Production > Runs**. 2. In the **Number of redline approvers required** field, enter the number of approvals required. # Configure intent control policies Source: https://docs.firstresonance.io/administration/quality-settings/configure-intent-control-policies Set how intent affects run execution, inventory availability, installs, and part quality in ION. Intent control policies determine what ION does when an item's intent is set to a particular value. > [!NOTE] > > Intent control policies appear only when intent features are enabled for your organization. ## Configure a policy 1. In ION, go to **Settings > Quality > Intent**. 2. Expand the section that holds the policy you want. 3. Turn on the policy, and choose a mode where one is offered. Where a policy offers **Hierarchical** or **Exact** matching, the policy compares items by intent rank (set in [Manage intent options](/administration/quality-settings/manage-intent-options)). **Hierarchical** accepts any intent at or above the required tier; **Exact** requires the same tier. ## Run Controls | Policy | What it does | | - | - | | **Require Intent on Run Create** | Makes intent mandatory when a run is created. | | **Require Intent on Run Update** | Prevents clearing a run's intent once it has been set. | | **Require Intent on Run Step Start** | Makes intent mandatory when a run step starts. | | **Run Intent Sync** | Copies a run's intent to its attached part inventory when the inventory has no intent set. When the run's intent is a lower tier than the inventory's, the **Downgrade inventory on mismatch** option controls whether the inventory is downgraded to match. Assigning a run intent higher than the inventory's current intent is not permitted. | **Require Intent on Run Create**, **Require Intent on Run Update**, and **Require Intent on Run Step Start** can each be limited to specific procedure types, so only runs of those types require intent. ## Inventory Controls | Policy | What it does | | - | - | | **Require Kit Intent Match** | Blocks kitting when kitted inventory intent doesn't meet the intent of the run's assembly inventory. When the assembly has no intent, or the run has no assembly, the run's own intent applies. Checked both when an item is added to a kit and when the kit is delivered to an assembly. Offers **Hierarchical** or **Exact** matching. See [What the kit intent match hides](#what-the-kit-intent-match-hides). | | **PO Line Intent Sync** | Propagates intent from a purchase order line to the on-order inventory created from it. | | **Issue Intent Update** | When an issue is resolved, applies an intent to the affected inventory based on the issue's disposition type. You set the disposition-type-to-intent mapping in this policy with **Map disposition types to intent options** and **Add mapping**. A disposition type with no mapping leaves the inventory's intent unchanged. | | **Required at Manual Inventory Create** | Makes intent mandatory when you create inventory by hand. | ### What the kit intent match hides **Require Kit Intent Match** doesn't only block a kitting attempt. While it's on, ION also leaves stock whose intent would fail out of what it offers a picker in the first place: * The kit's pick list omits it, for a single kit and for a pick run alike. * The kit's fillability score is computed without it, so a kit whose only remaining stock has the wrong intent reads short rather than fillable. * On the **Kitting** page, each line's kit picker and its available count leave it out, and the line shows how much stock is hidden for the wrong intent. The comparison is against the intent on the run's own assembly inventory, using the mode the policy is set to. A kit with no run, or a run whose assembly carries no intent, is unconstrained. Once the assembly does carry an intent, stock with no intent at all doesn't match it. > [!NOTE] > > A kit's stored fillability score is recalculated when its own inputs change, not when the policy itself is turned on or off. A kit already open when you change the setting keeps its previous score until its next change. Its pick list is correct immediately either way. ## Install Controls | Policy | What it does | | - | - | | **Require Install Intent Match** | Blocks an install when the child part's intent doesn't meet the parent assembly's intent. Offers **Hierarchical** or **Exact** matching. | | **Downgrade on Install** | Lowers a child part's intent to match the parent when it's installed in an aBOM, but only when the parent assembly's intent is lower than the child's. If the parent's intent is equal or higher, the child is unchanged. | ## Part Quality | Policy | What it does | | - | - | | **Part Quality Check** | Keeps part inventory intent from exceeding the part's intent. Applies wherever intent is assigned to inventory: manual assignment, receipt from a purchase order line, run intent sync, and issue resolution. In **Block** mode, an exceeding value raises an error; in **Downgrade** mode, the inventory intent is lowered to match the part. | # Configure issue creation and approvals Source: https://docs.firstresonance.io/administration/quality-settings/configure-issue-creation-and-approvals Auto-create issues on run step failure and set how many approvals are required to close an issue. ## Auto-create issues on run step failure When this setting is on, ION automatically creates an issue ticket whenever a run step is marked as failed. 1. In ION, go to **Settings > Quality > Issues**. 2. Turn on **Create issues on run step failure**. ## Set the number of approvals required 1. In ION, go to **Settings > Quality > Issues**. 2. In the **Number of approvals required** field, enter the number of approvals needed before an issue can be closed. # Enable auto-submit redlines Source: https://docs.firstresonance.io/administration/quality-settings/enable-auto-submit-redlines Automatically apply a redline's changes once all required reviewers have approved. When auto-submit is on, ION applies a redline's changes as soon as all required reviewers have approved. When off, you must manually submit the redline after all approvals are collected. ## Enable auto-submit redlines 1. In ION, go to **Settings > Quality > Redlines**. 2. Turn on **Auto Submit Redlines**. # Manage disposition types Source: https://docs.firstresonance.io/administration/quality-settings/manage-disposition-types Create, edit, and delete issue disposition types, along with their availability behavior and approval roles. A disposition type defines a disposition decision for your organization: its name, how it affects the availability of the affected inventory, and which roles must approve it before the issue can progress. ## Add a disposition type 1. In ION, go to **Settings > Quality > Issues**. 2. In the **Disposition types** section, type a name in **New disposition type name** and click **Add**. ## Configure a disposition type Expand a disposition type to set: | Setting | What it does | | - | - | | **Active** | Makes the type available to apply to issues. Turn it off to retire a type without deleting it. | | **Description** | Optional explanation of when to use the type. | | **Availability** | How the affected inventory behaves once the disposition is applied. Changing it prompts a confirmation that shows how much inventory is affected. | | **Auto-resolve** | When on, issues with this disposition resolve automatically once approved, skipping **In Review**. | The **Availability** options are: | Option | Effect | | - | - | | **Available Immediately** | Inventory is available as soon as the disposition is applied. | | **Release on Resolve** | Inventory becomes available only when the issue reaches **Resolved**. | | **Permanently Unavailable** | Inventory stays locked out. | ### Approval roles Each disposition type defines who must approve at each stage of the issue. On an expanded disposition type in **Settings > Quality > Issues**: 1. In **Approver Roles**, click **Add role** and set the number of approvers required from that role. These roles must approve before an issue can leave **Pending**. 2. In **Closure Roles**, click **Add role** and set the number of approvers required. These roles must approve before an issue can reach **Resolved**. To remove a role from either list, click the remove control next to it. ## Edit a disposition type Expand the type and edit its fields in place. Changes save automatically. Changing **Availability** prompts a confirmation before it takes effect. To stop offering a type without removing it, turn off **Active**. ## Delete a disposition type Click the trash icon on the disposition type. # Manage intent options Source: https://docs.firstresonance.io/administration/quality-settings/manage-intent-options Add, edit, and remove the intent values available in your organization. Intent options are the quality tiers you assign to items, for example **Flight**, **Production**, and **Development**. Their order sets their rank: the option at the top is the strictest, highest-quality tier, and rank decreases as you move down. Intent control policies that compare intent, such as kit and install matching, use this ranking. ## Add an intent option 1. In ION, go to **Settings > Quality > Intent**. 2. In the **Options** section, click **Add Option**. 3. Type a name in the new option's value field. ## Edit an intent option 1. In ION, go to **Settings > Quality > Intent**. 2. In the **Options** section, click the value field for the option you want to edit and update the text. To configure the **Inspection Run Required** setting for an option, expand the option row and turn **Inspection Run Required** on or off. When it's on, receiving inventory that carries this intent automatically creates the part's inspection runs. ## Reorder intent options In the **Options** section, drag an option row by its grip handle to reorder it. ## Remove an intent option 1. In ION, go to **Settings > Quality > Intent**. 2. In the **Options** section, click **X** next to the option you want to remove. ## Where intent appears You can edit an item's intent on the **Inventory** page and in a part's **Inventory** section. Everywhere else, intent is read-only. # Rename fields Source: https://docs.firstresonance.io/administration/quality-settings/rename-fields Replace default ION field labels with your organization's terminology, from Settings. The label you enter replaces the default wherever that field appears in ION. The renameable fields are grouped below by the Settings page where you rename them. ## Issues Rename these on **Settings > Quality > Issues**, in the **Issue ticket label configuration** section. | Default field | Alias input | | - | - | | Disposition | **Disposition alias** | | Cause condition | **Cause condition alias** | | Expected condition | **Expected condition alias** | ## Further actions Rename these on **Settings > Quality > Further Actions**. | Default field | Alias input | | - | - | | Problem statement | **Problem statement alias** | | Analysis notes | **Analysis notes alias** | | Resolution | **Resolution alias** | ## Intent Rename this on **Settings > Quality > Intent**. | Default field | Alias input | | - | - | | Intent | **Intent Alias** | ## Rename a field 1. Go to the Settings page listed for the field you want to rename. 2. Enter your preferred label in that field's alias input. # Set the default availability behavior for issues Source: https://docs.firstresonance.io/administration/quality-settings/set-default-availability-behavior Control whether inventory tied to an open issue remains available or is put on hold by default. The default availability behavior applies to inventory tied to issues that don't yet have a disposition type assigned. Once a disposition type is assigned, that type's own availability behavior takes over. ## Set the default availability behavior 1. In ION, go to **Settings > Quality > Issues**. 2. In the **Default availability behavior** field, select the behavior you want. 3. Click **Confirm**. # Security and compliance Source: https://docs.firstresonance.io/administration/security-and-compliance How First Resonance handles backups, encryption, and data access for ION. ## Backups First Resonance performs daily backups of your ION environment. Backups are retained for 25 days and are reserved for emergency database recovery. ## Encryption ION uses AWS Key Management Service (KMS) to manage encryption keys. AWS KMS is designed so that no one (including First Resonance) can retrieve your plaintext keys. ## GovCloud access If you're on the GovCloud version of ION and traveling internationally, you can still access ION from outside the United States by connecting through a VPN. # SIEM integration Source: https://docs.firstresonance.io/administration/siem-integration How to pull ION data into your SIEM using the GraphQL API. ION doesn't have a native SIEM connector, but you can pull any ION data into your SIEM by querying the GraphQL API on a schedule. For setup instructions, see [API reference](/api/getting-started). ## Polling pattern A typical polling loop: 1. Read the `last_polled_at` timestamp from your pipeline's state store. 2. Query ION for records where `updatedAt > last_polled_at`. 3. Transform and forward the results to your SIEM ingest endpoint. 4. On success, write the current timestamp as the new `last_polled_at`. The data most commonly relevant to SIEM ingestion includes: * **Runs**: production order lifecycle events (created, started, completed, paused). * **Issues**: quality events, nonconformances, and dispositions. * **Inventory**: adjustments, transfers, and lot/serial number changes. * **Users and roles**: membership changes, permission grants, and deactivations. ## Alternatives to polling If your architecture can accept inbound HTTPS traffic, [webhooks](/api/guides/webhooks) let ION push change events to your endpoint in near-real time, which reduces polling overhead and latency. Webhooks cover the same resources and include the before/after state of the changed record. Use polling when your SIEM sits behind a firewall that blocks inbound connections, or when your compliance posture requires a strict pull-only model. # Allow kitting of WIP inventory for outside processing Source: https://docs.firstresonance.io/administration/supply-chain-settings/allow-wip-osp-kitting Let inventory that is out at a supplier on an outside-processing purchase order be kitted while it is still in WIP. Inventory in **WIP** is not kittable. When this setting is on, one exception applies: inventory linked to a purchase order line through an [outside-processing](/build-hardware/runs-and-execution/outside-processing) run step can be kitted while it is still in **WIP**. All other WIP inventory stays un-kittable. The exception applies to every kitting path, including barcode scanning. ## Allow kitting of WIP inventory for OSP 1. In ION, go to **Settings > Supply Chain > Parts Inventory**. 2. Turn on **Allow kitting of WIP inventory for OSP**. # Configure demand settings Source: https://docs.firstresonance.io/administration/supply-chain-settings/configure-demand-settings Control how ION calculates material demand and what counts as supply when running Autoplan. Demand settings control which parts of the BOM drive demand calculations and how supply is counted during Autoplan runs. ## Configure demand settings 1. In ION, go to **Settings > Supply Chain > Plans**. 2. Turn on or off the settings you need: | Setting | What it does | | - | - | | **Drive demand below purchased parts** | Extends demand calculations to sub-components beneath purchased parts in the BOM. | | **Drive demand from kits** | Includes kit requirements when calculating material demand. | | **Group plan items with same date** | Consolidates plan line items with the same target date into a single group. | | **Exclude uncommitted purchase orders** | Counts only ordered POs as supply; draft, requested, and approved POs are excluded. | # Configure inventory merge behavior Source: https://docs.firstresonance.io/administration/supply-chain-settings/configure-inventory-merge-behavior Turn inventory merging on or off for your organization. This setting turns inventory merging on or off. It's on by default. With it on, ION merges matching records into a single new inventory record: after you edit or move a record, and automatically after a receipt or an aBOM uninstall. With it off, ION runs none of these merges. For when merging happens and which records match, see [Merge inventory](/manage-supply-chain/inventory/merge-inventory). A merge after an edit or a move also depends on the user's role. A user whose role lacks the **MergePartInventoryV2** permission can still move inventory, but ION doesn't merge it. For how to change a role's permissions, see [Manage role permissions](/administration/users-and-permissions/manage-role-permissions). > [!WARNING] > > Depending on your settings, your org can also have an earlier merge behavior turned on. It ignores this setting and the location's **Exclude from Inventory Merge** option, and it runs for any user whose role has the **MergePartInventory** permission. So records can still merge after an edit or a move while this setting is off. To stop a user from merging, remove both **MergePartInventory** and **MergePartInventoryV2** from their role. ## Configure inventory merge behavior 1. In ION, go to **Settings > Supply Chain > Parts Inventory**. 2. In the **Merge Inventories** section, turn **Merge into single new inventory** on or off. # Configure location constraints Source: https://docs.firstresonance.io/administration/supply-chain-settings/configure-location-constraints Enforce the can-hold-inventory and pickable switches that each location carries. Every location carries a **Can Hold Inventory** switch and a **Pickable** switch. Two organization settings decide whether ION enforces them. Both settings are off by default, so the switches are advisory until you turn enforcement on. ## When to turn enforcement on The two settings answer different questions, so they are worth deciding separately. **Enforce can hold inventory** is about where stock is allowed to *be*. Turn it on when your location tree contains places that are not real storage, such as in-transit nodes, work centers, staging areas and scrap, and an operator parking stock there would misstate where your inventory is. Leave it off if your floor legitimately puts inventory anywhere and you would rather not block a move at the moment someone is making it. **Enforce pickable** is about where stock may be *taken from*. Turn it on when some inventory is physically present but must not be consumed: quarantine, inspection hold, customer-owned stock, or a bin that only a supervisor should open. Leave it off when everything on the floor is fair game for a kit. > [!NOTE] > > Turn the switches on your locations first, then turn enforcement on. Enforcement applies to > locations as they are marked today, so a floor that has not been marked up yet will either reject > moves it should allow, or keep pickable stock out of kits. ## Configure location constraints 1. In ION, go to **Settings > Supply Chain > Locations**. 2. Turn on **Enforce can hold inventory** to stop inventory from being allocated or moved into locations that aren't marked as able to hold inventory. 3. Turn on **Enforce pickable** to exclude inventory stored at locations that aren't marked pickable from kitting and pick lists. Each switch saves as you change it. ## What each setting enforces **Enforce can hold inventory** applies wherever inventory gets a location: * Setting a location on an inventory record fails when that location isn't marked **Can Hold Inventory**, including through the parts inventory importer. * The location pickers used to receive parts, add or split inventory, add tool inventory, and set a kit's current location list only locations that can hold inventory. * Turning off **Can Hold Inventory** on a location that still holds inventory fails. Move the inventory out first. ![Location detail page with Can Hold Inventory still switched on and an error: Cannot disable inventory-holding for 'A1-01' while it still holds inventory. Move the inventory out first.](https://mintcdn.com/firstresonance/GDdZzJhN3ghZoS8V/images/build-hardware/location-can-hold-inventory-refused.png?fit=max\&auto=format\&n=GDdZzJhN3ghZoS8V\&q=85\&s=1b5c7a61b9599b26d37ee8193138257b) With enforcement on, turning off Can Hold Inventory on a bin that still holds stock is refused and the switch stays on. **Enforce pickable** applies to kitting: * Adding inventory to a kit fails when the inventory sits at a location that isn't marked **Pickable**. * Kit pick lists, pick runs and a kit's fillability skip inventory at locations that aren't marked pickable. > [!WARNING] > > The available count beside a kit line on the **Kitting** page, and its **Inventory Breakdown**, still include stock at locations that aren't marked pickable. That stock is listed as available, but ION refuses it when you try to add it to the kit, with the message *the location is not marked pickable*. ![Inventory Breakdown for kit line DEMO-SCREW-M4 listing available stock at bins A1-01 and A2-01 and 10 units at Quarantine Cage](https://mintcdn.com/firstresonance/GDdZzJhN3ghZoS8V/images/build-hardware/kit-line-availability-includes-non-pickable.png?fit=max\&auto=format\&n=GDdZzJhN3ghZoS8V\&q=85\&s=af64b51074c2e20752fc609189b7a59e) Enforce pickable is on, yet the kit line's breakdown lists 10 units at Quarantine Cage, a location that isn't pickable, as available. Inventory with no location at all stays eligible under both settings. > [!NOTE] > > **Pickable** also decides what the pick order can sequence. Only pickable, unarchived locations are stops on a walk, so only those take a pick order. See [Manage locations](/build-hardware/locations-and-work-centers/manage-locations). # Configure part revision schemes Source: https://docs.firstresonance.io/administration/supply-chain-settings/configure-part-revision-schemes Define the naming formats used to track part revisions in ION. Revision schemes define how part revisions are named (for example, alphabetic A, B, C or numeric 1, 2, 3). You can configure multiple schemes and set one as the default. ## Revision scheme format A revision scheme's format defines the sequence of characters a revision can use. You build it from segments and separators: * Click **A–Z** to add an alphabetic segment (A, B, C, and so on). * Click **0–9** to add a numeric segment (1, 2, 3, and so on). * To place a separator between segments, type a single character in the **Separator** field and click **Add**. A format must include at least one numbering segment (**A–Z** or **0–9**). ## Add a revision scheme 1. In ION, go to **Settings > Supply Chain > Parts**. 2. In the **Part Revision Schemes** section, fill in the new scheme form: * Enter a **name** for the scheme. * Build the **format**, as described in [Revision scheme format](#revision-scheme-format). * Optional: Turn on **Overflow** to continue the sequence past the last defined value. * Optional: Turn on **Default** to make this the default scheme. 3. Click **Create Scheme**. ## Edit a revision scheme 1. In ION, go to **Settings > Supply Chain > Parts**. 2. In the **Part Revision Schemes** section, click a scheme to expand it. 3. Update the name, **Allow overflow** setting, or **Default** flag as needed. ## Delete a revision scheme 1. In ION, go to **Settings > Supply Chain > Parts**. 2. In the **Part Revision Schemes** section, click the trash icon on the scheme's row. # Configure purchase order approval workflow Source: https://docs.firstresonance.io/administration/supply-chain-settings/configure-purchase-order-approval Define the approval levels required before a purchase order can proceed in ION. The purchase order approval workflow defines how many levels of approval a PO requires, who is responsible at each level, and the cost threshold that triggers each level. ## How approval levels work Each approval level activates when a PO's total cost meets or exceeds that level's **Cost Threshold**. ## Configure the approval workflow 1. In ION, go to **Settings > Supply Chain > Purchases**. 2. In the **Approval Policy** section, click **Add Level**. 3. For each level, fill in the fields: * **Role**: the role you must have to approve at this level. * **Team**: the team responsible for approvals at this level. Can be left for you to select at review time. * **Cost Threshold**: the minimum PO total (in your org's currency) that triggers this level. 4. Drag levels into the order in which you want approvals to happen. ## Configure approval reset thresholds If a PO is edited after approval, ION can automatically reset approvals and require the workflow to run again. Set this in the **Approval Reset Cost Threshold** section: | Field | Description | | - | - | | **By Percentage** | Reset approvals if the PO total changes by this percentage. | | **By Amount** | Reset approvals if the PO total changes by this amount in your org's currency. | | **Condition** | Whether both thresholds must be met (**and**) or either one is enough (**or**) to trigger a reset. | # Disable automatic location update on run start Source: https://docs.firstresonance.io/administration/supply-chain-settings/disable-auto-location-update Keep inventory at its current location instead of moving it to the step location when a run starts. By default, ION moves inventory to the step's location when a run starts. When this setting is on, inventory stays at its current location instead. ## Disable automatic location update on run start 1. In ION, go to **Settings > Supply Chain > Parts Inventory**. 2. Turn on **Disable auto location update on run start**. # Enable part interchangeability Source: https://docs.firstresonance.io/administration/supply-chain-settings/enable-part-interchangeability Allow any revision of a part to be used in place of the specific revision specified in the aBOM. When part interchangeability is on, you can kit or install any revision of a part wherever the aBOM specifies a particular revision. > [!NOTE] > > Use this functionality when your organization enforces that part numbers have the same form, fit, and function, and uses different part numbers when they do not. ## Enable part interchangeability 1. In ION, go to **Settings > Supply Chain > Parts**. 2. In the **Part Interchangeability** section, turn on **Allow any part revision to be used**. ## How it behaves Serial numbers follow the same logic. With interchangeability off, a serial can be reused on a different revision of the same part number, so a unit that moves from one revision to the next keeps its serial. With interchangeability on, revisions count as one part, so the serial has to be unique across every revision of that part number. For more information, see [Serial and lot tracking](/build-hardware/parts/serial-lot-tracking). # Manage projects and charge accounts Source: https://docs.firstresonance.io/administration/supply-chain-settings/manage-projects Maintain the project and charge account lists that purchase order lines are tagged with. Purchase order lines can carry a **Project** and a **Charge Account**, so a purchase can be traced to the programme it's for and the account it's charged to. Both come from lists your organization maintains. The two lists are independent: a project isn't tied to one charge account, so the same project can be charged to different accounts on different lines. Each entry has a **code**, which is unique in your organization, and a **title**. Pickers show both and let you search either. ## Manage projects 1. In ION, go to **Settings > Supply Chain > Projects**. 2. To add a project, click **Create Project** and enter its code and title. 3. To edit a project, click its code. 4. To retire a project, click the archive icon on its row. It moves to the **Archived** tab, where **Unarchive** brings it back. ![Projects settings page with Active and Archived tabs, a search box filtered to PRJ, and a table of project codes, titles, Active status badges, and archive icons, plus a Create Project button](https://mintcdn.com/firstresonance/X2Ho-zP06KM4tgvR/images/administration/projects-settings.png?fit=max\&auto=format\&n=X2Ho-zP06KM4tgvR\&q=85\&s=4d6129c2d827bbce3af6f0f9995c0000) The Projects settings page, with Active and Archived tabs. Archiving doesn't remove a project from purchase order lines that already use it. Those lines keep showing it, but it can't be picked for new lines. An archived project can't be edited from this page: only **Unarchive** is offered. Creating a project needs the **CreateProject** permission, and editing or archiving one needs **UpdateProject**. Admins have both. Someone with neither sees the list as read-only, with a note that projects may be managed in your organization's ERP. To grant the permissions, see [Manage role permissions](/administration/users-and-permissions/manage-role-permissions). ## Manage charge accounts Charge accounts have no settings page yet. They're maintained through the API: `createChargeAccount` takes a `code`, a `title`, and optionally `archived`; `updateChargeAccount` takes the account's `id` and `etag` plus any of those fields; and `deleteChargeAccount` takes an `id` and `etag`. Archiving a charge account works the same way as archiving a project. ## Retire an entry: archive, don't delete Archive a project or charge account to retire it. The API also has `deleteProject` and `deleteChargeAccount`, but a delete is refused while any purchase order line still uses the entry, so it only works on entries that were never used. # Manage requirements Source: https://docs.firstresonance.io/administration/supply-chain-settings/manage-requirements Create and manage terms and conditions and quality clauses used on purchase orders in ION. Requirements are reusable terms and conditions or quality clauses that can be attached to purchase orders. Terms cover payment terms and conditions; quality clauses set requirements for a supplier to deliver against on each PO line, such as a certificate of conformance or a dimensional inspection report. ## Create a requirement 1. In ION, go to **Settings > Supply Chain > Requirements**. 2. Select the tab for the type you want to create: **Terms** or **Quality Clauses**. 3. Click **Create Term** or **Create Quality Clause**. 4. Fill in the fields: * For a term: * **Title** (required): name of the term as it appears on the PO. * **Requirement** (optional): full text of the term or condition (rich text). * For a quality clause: * **Reference** (required): a short identifier code for the clause, for example `QC-101`. * **Title** (required): name of the clause as it appears on the PO. * **Requirement** (optional): full text of the quality clause (rich text). 5. Click **Create**. ## Edit a requirement 1. In ION, go to **Settings > Supply Chain > Requirements**. 2. Select the tab for the requirement type: **Terms** or **Quality Clauses**. 3. In the list, click the requirement's **Title**. 4. Make your changes and click **Save**. ## Archive a quality clause Archive a quality clause to stop it from being attached to new purchase order lines or parts. A part or PO line that already has the clause keeps it. Only quality clauses can be archived. 1. In ION, go to **Settings > Supply Chain > Requirements** and select the **Quality Clauses** tab. 2. In the clause's row, click **Archive quality clause**. To restore a clause, open **Display**, turn on **Show archived**, then click **Unarchive quality clause** in the clause's row. ## Delete a requirement 1. In ION, go to **Settings > Supply Chain > Requirements**. 2. Select the tab for the requirement type: **Terms** or **Quality Clauses**. 3. In the actions column of the requirement's row, click the trash icon. 4. Confirm the deletion in the dialog, then click **Delete**. > [!WARNING] > > Deleting a requirement removes it permanently. This cannot be undone. # Manage units of measure Source: https://docs.firstresonance.io/administration/supply-chain-settings/manage-units-of-measure Add and remove the units of measure available for inventory quantities in ION. Units of measure are the quantity labels available when tracking inventory (for example, `each`, `kg`, `m`). ## Add a unit of measure 1. In ION, go to **Settings > Supply Chain > Inventory**. 2. In the **Units of measure** field, type the unit you want to add. 3. Press **Enter** or click **Add**. ## Remove a unit of measure 1. In ION, go to **Settings > Supply Chain > Inventory**. 2. In the units list, click **X** next to the unit you want to remove. # Restrict installs to the assigned kit Source: https://docs.firstresonance.io/administration/supply-chain-settings/restrict-installs-to-the-assigned-kit Require that a run installs only the inventory kitted to it. A run can normally install any eligible inventory, whether or not it was kitted for that run. Turn this setting on when the kit is meant to be the authority on what goes into a build, so stock gathered for one run cannot be consumed by another. ## Restrict installs to the assigned kit 1. In ION, go to **Settings > Supply Chain > Part Kits**. 2. Turn on **Restrict installs to the kit assigned to the run**. The setting saves as you change it, and applies to every run in the organization. ## What it enforces While the setting is on, inventory kitted to another run cannot be installed. An operator working a run sees only the inventory that run's kit holds. Kits release their inventory when they are completed or canceled, so stock held by a kit is not stranded: once the kit is done with it, the inventory is available to other runs again. > [!NOTE] > > The restriction is about *which* kit the inventory belongs to, not whether it is kitted at all. > Leave the setting off if your operators routinely install stock that was never gathered into a > kit. # Set purchase order defaults Source: https://docs.firstresonance.io/administration/supply-chain-settings/set-purchase-order-defaults Pre-populate the assignee, default locations, currency, and payment terms on new purchase orders in ION. Purchase order defaults are pre-filled on new POs. ## Set purchase order defaults 1. In ION, go to **Settings > Supply Chain > Purchases**. 2. Configure the default values: * **Default ship to location**: The location pre-populated in the ship-to field. * **Default bill to location**: The location pre-populated in the bill-to field. * **Default currency**: The currency pre-selected on new POs. * **Default terms**: The payment terms pre-selected on new POs. The currency options come from your org's currency list, which has no settings page. To add a currency, such as `GBP`, run the `createCurrency` mutation through the [ION API](/api/getting-started) with the currency code as its `type`. Your role needs the **CreateCurrency** permission. ## Assign new purchase orders to their creator Turn on **Auto-assign purchase orders to their creator** in **Settings > Supply Chain > Purchases** to make whoever creates a purchase order its assignee. The setting is off by default. * An assignee chosen while creating the purchase order, whether a user or a team, always wins over the setting. * A purchase order created through the API or an integration is assigned to the account the integration runs as, not to a person. If you turn the setting on, make sure that's what you want for integration-created orders. * Only new purchase orders are affected. Existing ones keep their assignee. ![Purchases settings with the Auto-assign purchase orders to their creator toggle switched on, followed by Default ship to location, Default bill to location, Default currency, and Default terms](https://mintcdn.com/firstresonance/X2Ho-zP06KM4tgvR/images/administration/po-settings-auto-assign.png?fit=max\&auto=format\&n=X2Ho-zP06KM4tgvR\&q=85\&s=23b869e5d9151675a8a64461a37431e7) Auto-assign purchase orders to their creator, above the purchase order defaults. # Set working time Source: https://docs.firstresonance.io/administration/supply-chain-settings/set-working-time Define which days of the week count as working days when Autoplan schedules the parts you make. Purchased-part lead times always use calendar days. Working time controls which days ION counts as working days when calculating lead times in plans. The value is a standard cron expression. ION reads the day-of-week field (the fifth field) to determine which days count as working days. For example, `* * * * 1-5` means Monday through Friday. For the full cron specification, see the [crontab manpage](https://man7.org/linux/man-pages/man5/crontab.5.html). ## What working time applies to Working time applies when Autoplan schedules parts your organization makes: parts with a make or dual-source sourcing strategy. When Autoplan counts back from a need date to a start date for a made part, it counts only working days, and the start date always lands on a working day. Purchased-part lead times always use calendar days. Suppliers quote lead times in calendar time, so a supplier lead time of 35 days means 35 calendar days regardless of the working time setting. > [!TIP] > > If you record purchased-part lead times in business days, convert them to calendar days when entering them in ION. For a Monday through Friday schedule, multiply by 7/5. For example, 35 business days is about 49 calendar days. Working time affects only Autoplan scheduling. Purchase order dates, run schedules, and due dates elsewhere in ION use calendar days. ## Set working time 1. In ION, go to **Settings > Supply Chain > Plans**. 2. In the **Working time** field, enter a cron expression. # Deactivate a user Source: https://docs.firstresonance.io/administration/users-and-permissions/deactivate-a-user Remove a user's access to ION without deleting their history or records. Deactivating a user revokes their ability to log in to ION. Their account, activity history, and any records they created are preserved. ## Deactivate a user 1. In ION, go to **Settings > Users**. 2. On the user's row, click the actions menu (three dots). 3. Click **Deactivate User**. The user can no longer sign in. They stay in the **Users** list, so you can reactivate them. ## Reactivate a user 1. In ION, go to **Settings > Users**. 2. On the user's row, click the actions menu (three dots). 3. Click **Activate User**. The user can log in again. # Overview Source: https://docs.firstresonance.io/administration/users-and-permissions/index ION's access model: users, roles, and teams, how permissions flow, and the full permissions reference. ION's access model has three building blocks: * A **user** is an individual with sign-in credentials. * A **role** is a named, reusable set of permissions. * A **team** is a group of users you assign, notify, and route sign-offs to together. ## How permissions flow Permissions attach to roles, never to users directly. A user's access is the union of every role they hold, whether assigned to them directly or through a team they belong to. Roles are **additive**: adding one only grants access, so to narrow what someone can do, give them a role with fewer permissions rather than trying to subtract. Teams hold no permissions of their own, but a role assigned to a team grants its permissions to every current and future member. Permissions are organized into groups by feature area. Every create, update, and delete action has a permission; read actions generally don't, and read access is managed separately. Changes take effect immediately, and removing a permission from a role removes it from every user and team that holds it. To see a user's effective access, combine the roles on their profile with the roles from their teams. ## Provisioning | Approach | How it works | | - | - | | Manual | Invite users and assign roles directly in ION. | | SSO with role mapping | Roles map from your identity provider's groups (Okta, Entra ID) when users sign in. See [Set up SSO](/administration/authentication-settings/sso/set-up-sso). | ## System roles **Admin** and **Read-only** are system roles. Grant them directly to a user, not to a team. ## Permissions reference You assign permissions to roles, not to individual users. Read permissions (what a role can view) are managed separately and aren't listed here. To add permissions to a role, see [Manage role permissions](/administration/users-and-permissions/manage-role-permissions). | Permission | Description | | - | - | | `acceptStepProposal` | Apply a proposed revision to its procedure step. ION doesn't check this permission. `updateStep` governs it. | | `addAssetToItem` | Add an existing file attachment as an asset to an item. | | `addFileAttachmentToItem` | Add an existing file attachment to an item. | | `addHeaderToWebhookReceiver` | Add headers to a webhook receiver configuration. | | `addInputToPlan` | Add inputs to a plan. | | `addInventoriesToReceipt` | Add multiple inventories to a receipt. | | `addInventoryToPurchaseOrderLine` | Add inventory to a purchase order line. | | `addInventoryToReceipt` | Add a quantity of inventory to a receipt. | | `addItemsToReceipt` | Add items to a receipt from a purchase order, or without a PO. | | `addLabelToItem` | Add labels to an item (run, procedure, kit, etc.). | | `addLabelToProcedureFamily` | Add labels to a procedure family. | | `addOauthRedirectUri` | Add a callback URL or allowed origin to an OAuth app. | | `addPartInventoryToRunStep` | Add part inventory to a run step. | | `addPartsToKitFromMbom` | Add parts to a kit from an mBOM using the button on the kits page. | | `addPlanItemToPlan` | Add plan items to a plan in the results table, outside of plan inputs. | | `addRequirementToItem` | Add requirements to an item (for example, adding terms to a PO). | | `addResultToPlanItem` | Add results to a plan item. | | `addSubtypeToPart` | Add subtypes to a part (for example, Tool). | | `addUserToTeam` | Add users to a team. | | `archiveRun` | Archive a run. | | `assignReferenceDesignatorToRunStep` | Assign a reference designator to a run step. | | `assignRunStepBuildRequirement` | Map an existing build requirement to a run step. | | `attachPermissionGroupToRole` | Attach permission groups to a role. | | `attachRoleToTeam` | Attach roles to a team. | | `attachRoleToUser` | Attach roles to a user. | | `batchRunSteps` | Group multiple run steps into a batch for simultaneous execution. | | `cancelRun` | Cancel a run. | | `cancelRunStepRedline` | Cancel a redline. | | `checkIn` | Check in to a run. | | `checkOut` | Check out of a run. | | `checkSsoConnectionStatus` | Check whether SSO setup is complete. | | `cloneProcedure` | Clone a procedure. | | `convertResultsFromPlanItem` | Convert results from a plan item. | | `convertResultsFromPlanItems` | Convert results from multiple plan items. | | `copyField` | Copy a field in a step. | | `copyPurchaseOrder` | Copy a purchase order. | | `copyPurchaseOrderLine` | Copy a line item from a purchase order. | | `copyStandardStep` | Copy a standard step. | | `copyStep` | Copy a step. | | `copyStepToRun` | Copy a step to a run. | | `createAbomForPartInventory` | Create an aBOM for part inventory. | | `createAbomInstallation` | Create an aBOM installation. | | `createApiKey` | Create an API key. | | `createApprovalLevel` | Create an approval level in an approval workflow. | | `createAsset` | Add an asset to a run or procedure (for example, a file attachment). | | `createBarcodeLabel` | Create a barcode label from inventory, kits, or locations. | | `createBarcodePattern` | Create a new barcode pattern in organization settings. | | `createBarcodePrintRequest` | Generate a print request for barcodes. | | `createBarcodeTemplate` | Create a barcode template in organization settings. | | `createBuildRequirement` | Create a build requirement for an aBOM. | | `createBuildRequirementForBatch` | Add a build requirement to every unit in a run step's batch that doesn't already have it. | | `createBuildRequirementReferenceDesignator` | Create a build requirement reference designator for an aBOM. | | `createBuildRequirementSubstitute` | Create a build requirement substitute for an aBOM. | | `createComment` | Write comments in ION. | | `createContact` | Create a contact. | | `createCurrency` | Create a currency (API only). | | `createDatagridColumn` | Create a datagrid column in a datagrid step. | | `createDatagridRow` | Create a datagrid row in a datagrid step. | | `createDiffRequest` | Create a request to compare two objects, for example two versions of a procedure. | | `createFileAttachment` | Upload a file attachment. | | `createFurtherAction` | Create a further action (a corrective or preventive action). | | `createFurtherActionApproval` | Approve a further action. | | `createFurtherActionApprovalRequest` | Request approval of a further action. | | `createFurtherActionApprovalRole` | Add a role that can approve a further action. | | `createFurtherActionIssue` | Link a further action to an issue. | | `createFurtherActionPart` | Link a further action to a part. | | `createFurtherActionRun` | Link a further action to a run. | | `createImportJob` | Create an import job. | | `createIntentOption` | Create an intent option. | | `createInvite` | Invite another person to ION. | | `createIssue` | Create an issue ticket. | | `createIssueApproval` | Approve an issue. | | `createIssueApprovalRequest` | Ask someone to approve an issue. | | `createIssueDispositionType` | Create an issue disposition type in organization settings. | | `createIssueDispositionTypeRole` | Select the role that can approve a disposition type on an issue. | | `createIssuePartInventory` | Link part inventory to an issue. | | `createIssueRelation` | Add related issues. | | `createIssues` | Bulk create issues. | | `createKitForRun` | Create a kit from a run. | | `createLabel` | Create a label to tag a kit, procedure, run, etc. | | `createLocation` | Create a new location. | | `createLocationSubtype` | Create a location subtype. | | `createManyAbomInstallations` | Create multiple aBOM installations in one request. | | `createMbom` | Create an mBOM. | | `createMbomApproval` | Approve an mBOM. | | `createMbomApprovalRequest` | Request approval of an mBOM. | | `createMbomApprovalRole` | Add roles to approve an mBOM. | | `createMbomItem` | Add parts to an mBOM. | | `createMbomItemReferenceDesignator` | Add reference designators to mBOM items. | | `createMbomSubstitute` | Add a substitute to an mBOM item. | | `createMbomSubstitutes` | Add more than one substitute to an mBOM item. | | `createMrpJob` | Create a material requirements planning (MRP) job in Autoplan. | | `createMultipleMbomItems` | Import an mBOM. | | `createOrganizationDomain` | Add a domain to claim for the organization. | | `createOrganizationGlobalUniqueSerialNumberScheme` | Create a serial number scheme for the organization. | | `createOrganizationPartRevisionScheme` | Create a part revision scheme for the organization. | | `createOrUpdateMultipleMboms` | Create or update multiple mBOMs. | | `createOrUpdateMultipleMbomsCsv` | Create or update multiple mBOMs from a CSV file. | | `createOrUpdateMultipleParts` | Create or update multiple parts. | | `createPart` | Create a new part library item. | | `createPartInventories` | Bulk create part inventories. | | `createPartInventory` | Create a part inventory. | | `createPartKit` | Create a part kit. | | `createPartKitItem` | Add parts to a kit. | | `createPartKitItems` | Add multiple parts to a kit. | | `createPartProcedure` | Create a part-procedure relationship. | | `createPartRevision` | Create a part revision. | | `createPartSubtype` | Create a part subtype (used for tools). | | `createPickOverrideEvent` | Record that a picker chose different inventory or a different location than the one recommended on a pick run. | | `createPickRun` | Plan a pick run across a batch of kits. | | `createPlan` | Create a plan. | | `createPlanConstraint` | Create a plan constraint. | | `createPlanItem` | Create a plan item. | | `createPlanItemAllocation` | Create a plan item allocation. | | `createPlanReservation` | Create a plan reservation. | | `createPrintJob` | Create a print job, for example to print barcode labels. | | `createProcedure` | Create a procedure. | | `createProcedureApproval` | Approve a procedure. | | `createProcedureApprovalRequest` | Request approval of a procedure. | | `createProcedureApprovalRole` | Add a role that can approve a procedure. | | `createProcedureVersion` | Create a version of a procedure. | | `createPurchaseOrder` | Create a purchase order. | | `createPurchaseOrderApproval` | Approve a purchase order. | | `createPurchaseOrderApprovalLevel` | Create an approval level for a purchase order. | | `createPurchaseOrderApprovalRequest` | Ask another user to approve a purchase order. | | `createPurchaseOrderFee` | Add a fee to a purchase order. | | `createPurchaseOrderLine` | Create a purchase order line. | | `createReceipt` | Create a receipt. | | `createRedlineApproval` | Approve a redline on a run. | | `createRedlineApprovalRequest` | Ask another user to approve redlines. | | `createRedlineApprovalRequests` | Request approval of multiple redlines. | | `createRedlineApprovalRole` | Add a role that can approve a redline. | | `createRedlineApprovals` | Approve multiple redlines. | | `createRedlineRoleBasedApproval` | Approve a redline as part of a role-based approval. | | `createRedlineRoleBasedApprovalRequest` | Request role-based approval of a redline. | | `createRedlineRoleBasedApprovalRequests` | Request role-based approval of multiple redlines. | | `createRedlineRoleBasedApprovals` | Approve multiple redlines as part of role-based approvals. | | `createRequirement` | Create a requirement for purchasing. | | `createReview` | Create a review (via mBOMs, issues, procedures, etc.). | | `createReviewRequest` | Create a review request. | | `createRole` | Create a new role. | | `createRule` | Create a new rule. | | `createRun` | Create a new run. | | `createRunBatch` | Create a run batch. | | `createRuns` | Bulk create runs. | | `createRunStep` | Create a run step. | | `createRunStepBuildRequirementSubstitute` | Add a substitute part to a run step's build requirement. | | `createRunStepEdge` | Create a run step dependency. | | `createRunStepField` | Create a run step field. | | `createRunStepFieldValidation` | Add a run step field validation. | | `createSnapshotExportJob` | Create a snapshot export job. | | `createSsoSetupTicket` | Generate a self-service SSO setup link for an organization admin. | | `createStandardStepVersion` | Create a new version of a standard step. | | `createStep` | Create a new step in a procedure. | | `createStepApproval` | Create a step approval. | | `createStepApprovalRequest` | Create a step approval request. | | `createStepApprovalRole` | Add a role that can approve a step. | | `createStepEdge` | Create a step dependency. | | `createStepField` | Create a step field. | | `createStepFieldValidation` | Create a step field validation. | | `createStepPartRequirement` | Create an association between a step and an mBOM item. | | `createStepProposal` | Propose a revision to a procedure step. ION doesn't check this permission. `updateStep` governs it. | | `createStepRoleBasedApproval` | Approve a step as part of a role-based approval. | | `createStepRoleBasedApprovalRequest` | Request role-based approval of a step. | | `createSupplier` | Create a new supplier in the purchasing module. | | `createSupplierPart` | Create a part supplier. | | `createTeam` | Create a new team. | | `createUnitOfMeasurement` | Create a new unit of measurement. | | `createUserSubscription` | Subscribe yourself or another user to something in ION. | | `createWebhookHeader` | Create a webhook header. | | `createWebhookReceiver` | Create a webhook receiver. | | `createWebhookSubscription` | Create a webhook subscription. | | `deleteAbomInstallation` | Delete an aBOM installation. | | `deleteApiKey` | Delete an API key. | | `deleteApprovalLevel` | Delete an approval level from an approval workflow. | | `deleteAsset` | Delete an asset such as a file attachment. | | `deleteBarcodePattern` | Delete a barcode pattern. | | `deleteBuildRequirement` | Delete a build requirement. | | `deleteBuildRequirementReferenceDesignator` | Delete a build requirement reference designator. | | `deleteBuildRequirementSubstitute` | Delete a build requirement substitute. | | `deleteComment` | Delete a comment. | | `deleteContact` | Delete a contact. | | `deleteCurrency` | Delete a currency. | | `deleteDatagridColumn` | Delete a datagrid column. | | `deleteDatagridColumns` | Delete multiple columns from a datagrid. | | `deleteDatagridRow` | Delete a datagrid row. | | `deleteDatagridRows` | Delete multiple rows from a datagrid. | | `deleteFileAttachment` | Delete a file attachment. | | `deleteFurtherActionApprovalRequest` | Delete a further action approval request. | | `deleteFurtherActionApprovalRole` | Remove a role from a further action approval. | | `deleteFurtherActionIssue` | Remove the link between a further action and an issue. | | `deleteFurtherActionPart` | Remove the link between a further action and a part. | | `deleteFurtherActionRun` | Remove the link between a further action and a run. | | `deleteIntentOption` | Delete an intent option. | | `deleteIssueApprovalRequest` | Delete an issue approval request. | | `deleteIssueDispositionType` | Delete an issue disposition type. | | `deleteIssueDispositionTypeRole` | Delete an issue disposition type role. | | `deleteIssuePartInventory` | Delete an issue part inventory. | | `deleteIssueRelation` | Delete an issue relation. | | `deleteLabel` | Delete a label. | | `deleteLocation` | Delete a location. | | `deleteLocationSubtype` | Delete a location subtype. | | `deleteManyAbomInstallations` | Delete multiple aBOM installations in one request. | | `deleteMbom` | Delete an mBOM. | | `deleteMbomApprovalRequest` | Delete an mBOM approval request. | | `deleteMbomApprovalRole` | Delete an mBOM approval role. | | `deleteMbomItem` | Delete an mBOM item. | | `deleteMbomItemReferenceDesignator` | Delete an mBOM item reference designator. | | `deleteMbomSubstitute` | Delete an mBOM substitute. | | `deleteOauthApp` | Delete an OAuth application registration. | | `deleteOrganizationDomain` | Remove a claimed domain from the organization. | | `deleteOrganizationFurtherActionAttributes` | Delete further action custom attributes for the organization. | | `deleteOrganizationGlobalUniqueSerialNumberScheme` | Delete a global unique serial number scheme for the organization. | | `deleteOrganizationIssueAttributes` | Delete issue custom attributes for the organization. | | `deleteOrganizationLocationAttributes` | Delete location custom attributes for the organization. | | `deleteOrganizationMbomAttributes` | Delete mBOM custom attributes for the organization. | | `deleteOrganizationPartAttributes` | Delete part custom attributes for the organization. | | `deleteOrganizationPartInventoryAttributes` | Delete part inventory custom attributes for the organization. | | `deleteOrganizationPartKitAttributes` | Delete part kit custom attributes for the organization. | | `deleteOrganizationPartKitItemAttributes` | Delete part kit item custom attributes for the organization. | | `deleteOrganizationPartRevisionScheme` | Delete a part revision scheme for the organization. | | `deleteOrganizationPlanAttributes` | Delete plan custom attributes for the organization. | | `deleteOrganizationProcedureAttributes` | Delete procedure custom attributes for the organization. | | `deleteOrganizationPurchaseOrderAttributes` | Delete purchase order custom attributes for the organization. | | `deleteOrganizationPurchaseOrderLineAttributes` | Delete purchase order line custom attributes for the organization. | | `deleteOrganizationReceiptAttributes` | Delete receipt custom attributes for the organization. | | `deleteOrganizationRunAttributes` | Delete run custom attributes for the organization. | | `deleteOrganizationRunStepAttributes` | Delete run step custom attributes for the organization. | | `deleteOrganizationStepAttributes` | Delete step custom attributes for the organization. | | `deleteOrganizationSupplierAttributes` | Delete supplier custom attributes for the organization. | | `deletePart` | Delete a part. | | `deletePartInventory` | Delete part inventory. | | `deletePartInventoryBuildRequirement` | Delete a build requirement from part inventory. | | `deletePartKit` | Delete a part kit. | | `deletePartKitItem` | Delete a part kit item. | | `deletePartProcedure` | Delete a part-procedure relationship. | | `deletePartSubtype` | Delete a part subtype. | | `deletePlan` | Delete a plan. | | `deletePlanConstraint` | Delete a plan constraint. | | `deletePlanItem` | Delete a plan item. | | `deletePlanItemAllocation` | Delete a plan item allocation. | | `deletePlanReservation` | Delete a plan reservation. | | `deleteProcedure` | Delete a procedure. | | `deleteProcedureApprovalRequest` | Delete a procedure approval request. | | `deleteProcedureApprovalRole` | Remove a role that can approve a procedure. | | `deleteProcedureMbom` | Delete the mBOM associated with a procedure. | | `deletePurchaseOrder` | Delete a purchase order. | | `deletePurchaseOrderApprovalLevel` | Delete an approval level for a purchase order. | | `deletePurchaseOrderApprovalRequest` | Delete a purchase order approval request. | | `deletePurchaseOrderFee` | Delete a purchase order fee. | | `deletePurchaseOrderLine` | Delete a purchase order line. | | `deleteReceipt` | Delete a receipt. | | `deleteRedlineApprovalRequest` | Delete a redline approval request. | | `deleteRedlineApprovalRole` | Remove a role from a redline approval. | | `deleteRedlineRoleBasedApprovalRequest` | Delete a redline role-based approval request. | | `deleteRequirement` | Delete a requirement. | | `deleteReviewRequest` | Delete a review request. | | `deleteRole` | Delete a role. | | `deleteRule` | Delete a rule. | | `deleteRunStep` | Delete a run step. | | `deleteRunStepBuildRequirement` | Unmap a build requirement from a single run step. | | `deleteRunStepBuildRequirementSubstitute` | Remove a substitute part from a run step's build requirement. | | `deleteRunStepEdge` | Delete a run step dependency. | | `deleteRunStepField` | Delete a run step field. | | `deleteRunStepFieldValidation` | Delete a run step field validation. | | `deleteStep` | Delete a step. | | `deleteStepApprovalRequest` | Delete a step approval request. | | `deleteStepApprovalRole` | Remove a role from a step approval. | | `deleteStepEdge` | Delete a step dependency. | | `deleteStepField` | Delete a step field. | | `deleteStepFieldValidation` | Delete a step field validation. | | `deleteStepPartRequirement` | Delete an association between a step and an mBOM item. | | `deleteStepRoleBasedApprovalRequest` | Delete a step role-based approval request. | | `deleteSupplier` | Delete a supplier. | | `deleteSupplierPart` | Delete a part supplier. | | `deleteTeam` | Delete a team. | | `deleteUnitOfMeasurement` | Delete a unit of measurement. | | `deleteUserSubscription` | Delete a user subscription. | | `deleteWebhookHeader` | Delete a webhook header. | | `deleteWebhookReceiver` | Delete a webhook receiver. | | `deleteWebhookSubscription` | Delete a webhook subscription. | | `detachPermissionGroupFromRole` | Detach a permission group from a role. | | `detachRoleFromTeam` | Detach a role from a team. | | `detachRoleFromUser` | Detach a role from a user. | | `disableSsoConnection` | Disable the enterprise SSO connection for the organization. | | `dismissStepProposal` | Dismiss a proposed revision, leaving its procedure step unchanged. ION doesn't check this permission. `updateStep` governs it. | | `dispatchNotification` | Dispatch notifications. | | `fulfillPickRunStop` | Issue a pick run stop's stock into its kits. | | `generateReadEmbeddedAnalytics` | Generate read operations for embedded analytics. | | `generateRunSummary` | Generate a summary of a run. | | `generateWriteEmbeddedAnalytics` | Generate write operations for embedded analytics. | | `importKitItems` | Import kit items. | | `importKitItemsCsv` | Import kit items from a CSV file. | | `importStepsFromPdf` | Import steps from a PDF document. | | `installKitOnAbom` | Install a kit on an aBOM. | | `inviteOrganizationMember` | Send an invitation email to a new organization member. | | `issueItemToKit` | Issue an item to a kit. | | `linkOrganizationToAuth0` | Link an existing organization to its identity provider. | | `linkRunStepToPurchaseOrder` | Link an outside-processing run step to a purchase order. | | `mergeMultiplePartInventory` | Merge multiple freed inventory lots into their merge groups. | | `mergePartInventory` | Merge part inventory. | | `mergePartInventoryV2` | Merge multiple part inventory records into one. | | `mergeRunStep` | Merge a run step. | | `mergeRunStepToProcedure` | Merge a run step into a procedure. | | `mergeRunStepToRuns` | Merge a run step into runs. | | `moveItemToInventory` | Move an item to inventory. | | `moveKitInventoryToLocation` | Move kit inventory to a location. | | `provisionCustomer` | Provision a new customer organization. | | `registerOauthApp` | Register a new OAuth application for the organization. | | `removeAllInventoryFromKit` | Remove all inventory allocated to a kit. | | `removeAssetFromItem` | Remove an asset from an item without deleting the file attachment. | | `removeHeaderFromWebhookReceiver` | Remove a header from a webhook receiver. | | `removeInputFromPlan` | Remove an input from a plan. | | `removeInventoryFromPurchaseOrderLine` | Remove inventory from a purchase order line. | | `removeInventoryFromReceipt` | Remove inventory from a receipt. | | `removeItemFromReceipt` | Remove an item from a receipt. | | `removeLabelFromItem` | Remove a label from an item. | | `removeLabelFromProcedureFamily` | Remove a label from a procedure family. | | `removeOauthRedirectUri` | Remove a callback URL or allowed origin from an OAuth app. | | `removePartInventoryFromRunStep` | Remove part inventory from a run step. | | `removePlanItemFromPlan` | Remove a plan item from a plan. | | `removeRequirementFromItem` | Remove a requirement from an item. | | `removeResultFromPlanItem` | Remove a result from a plan item. | | `removeSubtypeFromPart` | Remove a subtype from a part. | | `removeUserFromTeam` | Remove a user from a team. | | `reorderApprovalLevel` | Reorder an approval level in an approval workflow. | | `reorderDatagridColumn` | Reorder datagrid columns. | | `reorderDatagridRow` | Reorder datagrid rows. | | `reorderIntentOptions` | Reorder intent options. | | `reorderPurchaseOrderLine` | Reorder purchase order lines. | | `reorderRunStepFields` | Reorder run step fields. | | `reorderRunSteps` | Reorder run steps. | | `reorderStepFields` | Reorder step fields. | | `reorderSteps` | Reorder steps. | | `replanPickRun` | Rebuild the unwalked part of a pick run after stock moves. | | `resendInvite` | Resend an invitation. | | `resetIssueApprovals` | Reset issue approvals. | | `resetPurchaseOrderApprovalLevels` | Reset the approval levels on a purchase order. | | `resetRedlineApprovals` | Reset the approvals on an open redline so it can be edited and resubmitted. | | `revokeInvite` | Revoke an invitation. | | `rotateSsoSigningCredentials` | Replace the identity provider signing certificate or metadata on the SSO connection. | | `saveReceipt` | Save a receipt after adding or removing items. | | `setDatagridValue` | Set the value of a datagrid cell. | | `splitManyPartInventory` | Split multiple part inventories. | | `splitPartInventory` | Split part inventory. | | `splitUnfulfilledPartKit` | Split an unfulfilled part kit. | | `submitRunAbomJustification` | Submit the aBOM completion justification on a run. | | `unassignReferenceDesignatorFromRunStep` | Unassign a reference designator from a run step. | | `unbatchRunSteps` | Remove run steps from a batch. | | `unlinkRunStepFromPurchaseOrder` | Unlink an outside-processing run step from its purchase order. | | `updateAbomInstallation` | Update an aBOM installation. | | `updateApiKey` | Update an API key. | | `updateApprovalLevel` | Update an approval level in an approval workflow. | | `updateBarcodeLabel` | Update a barcode label. | | `updateBarcodePattern` | Update a barcode pattern. | | `updateBarcodeTemplate` | Update a barcode template. | | `updateBuildRequirement` | Update a build requirement. | | `updateBuildRequirementReferenceDesignator` | Update a build requirement reference designator. | | `updateBuildRequirementSubstitute` | Update a build requirement substitute. | | `updateComment` | Update a comment. | | `updateContact` | Update a contact. | | `updateCurrency` | Update a currency. | | `updateDatagridColumn` | Update a datagrid column. | | `updateDatagridRow` | Update a datagrid row. | | `updateFurtherAction` | Update a further action. | | `updateFurtherActionApproval` | Update a further action approval. | | `updateFurtherActionApprovalRequest` | Update a further action approval request. | | `updateFurtherActionApprovalRole` | Update a further action approval role. | | `updateImportJob` | Update an import job. | | `updateInputToPlan` | Update a plan input. | | `updateIntentOption` | Update an intent option. | | `updateIssue` | Update an issue. | | `updateIssueApproval` | Update an issue approval. | | `updateIssueApprovalRequest` | Update an issue approval request. | | `updateIssueAttribute` | Update an issue custom attribute. | | `UpdateIssueAttributes` | Update the custom attribute values on an issue. | | `updateIssueDispositionType` | Update an issue disposition type. | | `updateIssueDispositionTypeRole` | Update an issue disposition type role. | | `updateLabel` | Update a label. | | `updateLocation` | Update a location. | | `updateLocationAttribute` | Update a location custom attribute. | | `UpdateLocationAttributes` | Update the custom attribute values on a location. | | `updateLocationSubtype` | Update a location subtype. | | `updateMbom` | Update an mBOM. | | `updateMbomApproval` | Update an mBOM approval. | | `updateMbomApprovalRequest` | Update an mBOM approval request. | | `updateMbomApprovalRole` | Update an mBOM approval role. | | `updateMbomAttribute` | Update an mBOM custom attribute. | | `UpdateMbomAttributes` | Update the custom attribute values on an mBOM. | | `updateMbomItem` | Update an mBOM item. | | `updateMbomItemReferenceDesignator` | Update an mBOM item reference designator. | | `updateMrpJob` | Update an MRP job in Autoplan. | | `updateMultiplePartInventory` | Update multiple part inventory records. | | `updateOauthApp` | Update an OAuth application registration. | | `updateOrganization` | Update organization details. | | `updateOrganizationBranding` | Update the branding on the organization login page. | | `updateOrganizationFurtherActionAttributes` | Update further action custom attributes for the organization. | | `updateOrganizationGlobalUniqueSerialNumberScheme` | Update a global unique serial number scheme for the organization. | | `updateOrganizationIssueAttributes` | Update issue custom attributes for the organization. | | `updateOrganizationLocationAttributes` | Update location custom attributes for the organization. | | `updateOrganizationMbomAttributes` | Update mBOM custom attributes for the organization. | | `updateOrganizationMfaPolicy` | Enable or disable the multi-factor authentication requirement for the organization. | | `updateOrganizationPartAttributes` | Update part custom attributes for the organization. | | `updateOrganizationPartInventoryAttributes` | Update part inventory custom attributes for the organization. | | `updateOrganizationPartKitAttributes` | Update part kit custom attributes for the organization. | | `updateOrganizationPartKitItemAttributes` | Update part kit item custom attributes for the organization. | | `updateOrganizationPartRevisionScheme` | Update a part revision scheme for the organization. | | `updateOrganizationPlanAttributes` | Update plan custom attributes for the organization. | | `updateOrganizationProcedureAttributes` | Update procedure custom attributes for the organization. | | `updateOrganizationPurchaseOrderAttributes` | Update purchase order custom attributes for the organization. | | `updateOrganizationPurchaseOrderLineAttributes` | Update purchase order line custom attributes for the organization. | | `updateOrganizationReceiptAttributes` | Update receipt custom attributes for the organization. | | `updateOrganizationRunAttributes` | Update run custom attributes for the organization. | | `updateOrganizationRunStepAttributes` | Update run step custom attributes for the organization. | | `updateOrganizationStepAttributes` | Update step custom attributes for the organization. | | `updateOrganizationSupplierAttributes` | Update supplier custom attributes for the organization. | | `updatePart` | Update a part. | | `updatePartAttribute` | Update a part custom attribute. | | `UpdatePartAttributes` | Update the custom attribute values on a part. | | `updatePartInventory` | Update part inventory. | | `updatePartInventoryAttribute` | Update a part inventory custom attribute. | | `UpdatePartInventoryAttributes` | Update the custom attribute values on part inventory. | | `updatePartKit` | Update a part kit. | | `updatePartKitAttribute` | Update a part kit custom attribute. | | `UpdatePartKitAttributes` | Update the custom attribute values on a part kit. | | `updatePartKitItem` | Update a part kit item. | | `updatePartKitItemAttribute` | Update a part kit item custom attribute. | | `UpdatePartKitItemAttributes` | Update the custom attribute values on a part kit item. | | `updatePartKits` | Update multiple kits in one request. | | `updatePartProcedure` | Update a part-procedure relationship. | | `updatePartSubtype` | Update a part subtype. | | `updatePlan` | Update a plan. | | `updatePlanAttribute` | Update a plan custom attribute. | | `UpdatePlanAttributes` | Update the custom attribute values on a plan. | | `updatePlanConstraint` | Update a plan constraint. | | `updatePlanItem` | Update a plan item. | | `updatePlanItemAllocation` | Update a plan item allocation. | | `updatePlanReservation` | Update a plan reservation. | | `updateProcedure` | Update a procedure. | | `updateProcedureApproval` | Update a procedure approval. | | `updateProcedureApprovalRequest` | Update a procedure approval request. | | `updateProcedureApprovalRole` | Update a procedure approval role. | | `updateProcedureAttribute` | Update a procedure custom attribute. | | `UpdateProcedureAttributes` | Update the custom attribute values on a procedure. | | `updatePurchaseOrder` | Update a purchase order. | | `updatePurchaseOrderApproval` | Update a purchase order approval. | | `updatePurchaseOrderApprovalLevel` | Update an approval level for a purchase order. | | `updatePurchaseOrderApprovalRequest` | Update a purchase order approval request. | | `updatePurchaseOrderAttribute` | Update a purchase order custom attribute. | | `UpdatePurchaseOrderAttributes` | Update the custom attribute values on a purchase order. | | `updatePurchaseOrderFee` | Update a purchase order fee. | | `updatePurchaseOrderLine` | Update a purchase order line. | | `updatePurchaseOrderLineAttribute` | Update a purchase order line custom attribute. | | `UpdatePurchaseOrderLineAttributes` | Update the custom attribute values on a purchase order line. | | `updatePurchaseOrderLines` | Update multiple purchase order lines. | | `updateReceipt` | Update a receipt. | | `updateReceiptAttribute` | Update a receipt custom attribute. | | `UpdateReceiptAttributes` | Update the custom attribute values on a receipt. | | `updateReceiptItem` | Update a receipt item. | | `updateRedline` | Update a redline. | | `updateRedlineApproval` | Update a redline approval. | | `updateRedlineApprovalRequest` | Update a redline approval request. | | `updateRedlineApprovalRequests` | Update multiple redline approval requests. | | `updateRedlineApprovalRole` | Update a redline approval role. | | `updateRedlineRoleBasedApproval` | Update a redline role-based approval. | | `updateRedlineRoleBasedApprovalRequest` | Update a redline role-based approval request. | | `updateRedlineRoleBasedApprovalRequests` | Update multiple redline role-based approval requests. | | `updateRequirement` | Update a requirement. | | `updateReview` | Update a review. | | `updateReviewRequest` | Update a review request. | | `updateRole` | Update a role's name. | | `updateRule` | Update a rule. | | `updateRun` | Update a run's information. | | `updateRunAbomJustification` | Update the aBOM completion justification on a run. | | `updateRunAttribute` | Update a run custom attribute. | | `UpdateRunAttributes` | Update the custom attribute values on a run. | | `updateRunBatch` | Update a run batch. | | `updateRunInventoryLocation` | Update the location of inventory associated with a run. | | `updateRuns` | Update multiple runs. | | `updateRunStep` | Update a run step, including changing its status. | | `updateRunStepAttribute` | Update a run step custom attribute. | | `UpdateRunStepAttributes` | Update the custom attribute values on a run step. | | `updateRunStepBuildRequirement` | Update a run step's build-requirement quantity. | | `updateRunStepField` | Update a run step field. | | `updateRunStepFieldValidation` | Update a run step field validation. | | `updateRunStepFieldValue` | Update the value of a run step field. | | `updateSession` | Update a check-in or check-out event. | | `updateSnapshotExportJob` | Update a snapshot export job. | | `updateStep` | Update step content in a procedure. Also required to create, accept, undo, and dismiss step proposals, which work only on a step in draft. | | `updateStepApproval` | Update a step approval. | | `updateStepApprovalRequest` | Update a step approval request. | | `updateStepApprovalRole` | Update a step approval role. | | `updateStepAttribute` | Update a step custom attribute in a procedure. | | `UpdateStepAttributes` | Update the custom attribute values on a step. | | `updateStepField` | Update a step field in a procedure. | | `updateStepFieldValidation` | Update a step field validation in a procedure. | | `updateStepPartRequirement` | Update an association between a step and an mBOM item. | | `updateStepRoleBasedApproval` | Update a step role-based approval. | | `updateStepRoleBasedApprovalRequest` | Update a step role-based approval request. | | `updateSupplier` | Update a supplier and their contact information. | | `updateSupplierAttribute` | Update a supplier's custom attributes. | | `UpdateSupplierAttributes` | Update the custom attribute values on a supplier. | | `updateSupplierPart` | Update a part supplier. | | `updateTeam` | Update a team's name and settings. | | `updateUnitOfMeasurement` | Update a unit of measurement in organization settings. | | `updateUser` | Update a user's profile and settings. | | `updateUserNotification` | Update user notifications. | | `updateWebhookHeader` | Update a webhook header. | | `updateWebhookReceiver` | Update a webhook receiver. | | `updateWebhookSubscription` | Update a webhook subscription. | | `verifyOrganizationDomain` | Verify ownership of a claimed domain. | # Invite a user Source: https://docs.firstresonance.io/administration/users-and-permissions/invite-a-user Send an email invitation to add a new person to your ION organization. ## Invite a user 1. In ION, go to **Settings > Users**. 2. Click **Invite User**. 3. In the **Email Address** field, enter the person's email address. This field is required. 4. Optional: Add more details: * In the **Name (optional)** field, enter the person's name. * In the **Message (optional)** field, enter a message to include in the invitation email. * To invite more than one person at once, click **Add More** and fill in the **Email Address** field for each additional invitee. The message applies to everyone in the invitation. 5. Click **Invite**. ION sends an invitation email to each address you entered. ## Manage pending invites The **Pending invites** section on **Settings > Users** lists invitations. Use the status filter to switch between **Pending**, **Accepted**, and **Revoked** invites. 1. In ION, go to **Settings > Users**. 2. Expand the **Pending invites** section. 3. For an invite that hasn't been accepted, choose an action: * Click **Resend invite** to send the invitation email again. * Click **Revoke invite**, then confirm, to invalidate the invite. The recipient can no longer use that invite link. # Manage role permissions Source: https://docs.firstresonance.io/administration/users-and-permissions/manage-role-permissions Configure which actions a role can perform by enabling or disabling permissions on the role's detail page. Add or remove a role's permissions on its detail page. For how permissions work, see [Users and permissions](/administration/users-and-permissions). ## Add permissions to a role 1. In ION, go to **Settings > Roles & Permissions**. 2. Click the role you want to configure. 3. On the role detail page, find the permission group you want to enable. 4. Select the checkbox next to a permission to enable it, or select the group's checkbox to enable every permission in that group at once. To enable all permissions currently shown, click **Enable All**. The **Enable All** and **Disable All** controls apply to the permissions that match your current search and filter. ## Remove permissions from a role On the role detail page, clear the checkbox next to a permission to disable it. To disable all permissions currently shown, click **Disable All**. Removing a permission from a role removes it from every user and team that holds that role. # Manage roles Source: https://docs.firstresonance.io/administration/users-and-permissions/manage-roles Create, archive, and delete the roles that group the permissions you assign to users and teams. A role is a named set of permissions you assign to users and teams. For the access model, common role patterns, and provisioning, see [Users and permissions](/administration/users-and-permissions). ## Create a role 1. In ION, go to **Settings > Roles & Permissions**. 2. Click **New Role**. 3. Enter a name for the role and click **Create Role**. ION creates the role and opens its detail page. The role has no permissions yet. ## Archive or unarchive a role Archiving a role hides it from the roles list without deleting it. 1. In ION, go to **Settings > Roles & Permissions**. 2. In the role's actions menu, click **Archive**. To bring an archived role back, check **Show archived** to list archived roles with the active ones, then click **Unarchive** in the role's actions menu. ## Delete a role 1. In ION, go to **Settings > Roles & Permissions**. 2. In the role's actions menu, click **Delete Role**. 3. In the confirmation dialog, click **Delete**. > [!WARNING] > > Deleting a role also removes it from every user and team it's assigned to, which can remove those users' access. Deletion can't be undone. # Manage team members Source: https://docs.firstresonance.io/administration/users-and-permissions/manage-team-members Add users to a team so they inherit the team's roles and can be assigned and notified as a group. ## Add users to a team 1. In ION, go to **Settings > Teams**. 2. Click the team you want to add users to. 3. In the **Users** card, click **Add Users**. 4. Select the users you want to add and click **Add Selected**. The users immediately inherit the team's roles. ## Remove a user from a team 1. In ION, go to **Settings > Teams**. 2. Click the team the user belongs to. 3. In the **Users** card, find the user you want to remove. 4. Click the delete icon next to their name. The user loses any permissions they held through this team. Permissions from other roles or teams are not affected. # Manage team roles Source: https://docs.firstresonance.io/administration/users-and-permissions/manage-team-roles Assign roles to a team so all team members inherit those permissions. ## Add roles to a team 1. In ION, go to **Settings > Teams**. 2. Click the team you want to configure. 3. In the **Roles** card, click **Add Roles**. 4. Select the roles you want to assign and click **Add Selected**. The roles take effect immediately for all team members. System roles such as **Admin** and **Read-only** can't be assigned to teams. Grant those directly to a user instead. ## Remove a role from a team 1. In ION, go to **Settings > Teams**. 2. Click the team you want to configure. 3. In the **Roles** card, find the role you want to remove. 4. Click the delete icon next to the role name. All team members lose the permissions from that role. Permissions held through other roles or teams are not affected. # Manage teams Source: https://docs.firstresonance.io/administration/users-and-permissions/manage-teams Create and delete the teams that group users so they can be assigned and notified collectively. ## Create a team 1. In ION, go to **Settings > Teams**. 2. Click **New Team**. 3. Enter a name for the team and click **Create Team**. ION creates the team and opens its detail page. ## Delete a team 1. In ION, go to **Settings > Teams**. 2. In the team's actions menu, click **Delete Team**. 3. Confirm the deletion. > [!WARNING] > > Deleting a team can't be undone. # Manage user roles Source: https://docs.firstresonance.io/administration/users-and-permissions/manage-user-roles Add or remove roles directly on a user's profile to control what they can do in ION. Assign roles directly on a user's profile. To give roles to many users, use [teams](/administration/users-and-permissions/manage-team-members). ## Assign a role 1. In ION, go to **Settings > Users**. 2. Click the user's name to open their profile. 3. In the **Roles** section, click **Add**. 4. Select the roles you want to assign. The roles take effect immediately. ## Remove a role 1. In ION, go to **Settings > Users**. 2. Click the user's name to open their profile. 3. In the **Roles** section, find the role you want to remove. 4. Click the delete icon next to the role name. The role is removed and the user loses any permissions they held through it. Permissions from other roles or teams are not affected. > [!NOTE] > > Removing the last role from a user does not deactivate their account. They can still log in but cannot perform any create, update, or delete actions. # UpdateIssueAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateIssueAttributes **mutation** `UpdateIssueAttributes(input: [UpdateIssueAttributeInput]!): UpdateIssueAttributes` ## Arguments **`input`**: `[UpdateIssueAttributeInput]!` (required) ## Returns `UpdateIssueAttributes` **`issueAttributes`**: `[IssueAttribute]` ## Examples ```graphql Mutation mutation UpdateIssueAttributes($input: [UpdateIssueAttributeInput]!) { UpdateIssueAttributes(input: $input) { issueAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "issueId": 1, "key": "string" } ] } ``` ```json Response { "data": { "UpdateIssueAttributes": { "issueAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateLocationAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateLocationAttributes **mutation** `UpdateLocationAttributes(input: [UpdateLocationAttributeInput]!): UpdateLocationAttributes` ## Arguments **`input`**: `[UpdateLocationAttributeInput]!` (required) ## Returns `UpdateLocationAttributes` **`locationAttributes`**: `[LocationAttribute]` ## Examples ```graphql Mutation mutation UpdateLocationAttributes($input: [UpdateLocationAttributeInput]!) { UpdateLocationAttributes(input: $input) { locationAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "locationId": 1 } ] } ``` ```json Response { "data": { "UpdateLocationAttributes": { "locationAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateMbomAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateMbomAttributes **mutation** `UpdateMbomAttributes(input: [UpdateMbomAttributeInput]!): UpdateMbomAttributes` ## Arguments **`input`**: `[UpdateMbomAttributeInput]!` (required) ## Returns `UpdateMbomAttributes` **`mbomAttributes`**: `[MbomAttribute]` ## Examples ```graphql Mutation mutation UpdateMbomAttributes($input: [UpdateMbomAttributeInput]!) { UpdateMbomAttributes(input: $input) { mbomAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "mbomId": 1 } ] } ``` ```json Response { "data": { "UpdateMbomAttributes": { "mbomAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePartAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePartAttributes **mutation** `UpdatePartAttributes(input: [UpdatePartAttributeInput]!): UpdatePartAttributes` ## Arguments **`input`**: `[UpdatePartAttributeInput]!` (required) ## Returns `UpdatePartAttributes` **`partAttributes`**: `[PartAttribute]` ## Examples ```graphql Mutation mutation UpdatePartAttributes($input: [UpdatePartAttributeInput]!) { UpdatePartAttributes(input: $input) { partAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "partId": 1 } ] } ``` ```json Response { "data": { "UpdatePartAttributes": { "partAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePartInventoryAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePartInventoryAttributes **mutation** `UpdatePartInventoryAttributes(input: [UpdatePartInventoryAttributeInput]!): UpdatePartInventoryAttributes` ## Arguments **`input`**: `[UpdatePartInventoryAttributeInput]!` (required) ## Returns `UpdatePartInventoryAttributes` **`partInventoryAttributes`**: `[PartInventoryAttribute]` ## Examples ```graphql Mutation mutation UpdatePartInventoryAttributes($input: [UpdatePartInventoryAttributeInput]!) { UpdatePartInventoryAttributes(input: $input) { partInventoryAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "partInventoryId": 1 } ] } ``` ```json Response { "data": { "UpdatePartInventoryAttributes": { "partInventoryAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePartKitAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePartKitAttributes **mutation** `UpdatePartKitAttributes(input: [UpdatePartKitAttributeInput]!): UpdatePartKitAttributes` ## Arguments **`input`**: `[UpdatePartKitAttributeInput]!` (required) ## Returns `UpdatePartKitAttributes` **`partKitAttributes`**: `[PartKitAttribute]` ## Examples ```graphql Mutation mutation UpdatePartKitAttributes($input: [UpdatePartKitAttributeInput]!) { UpdatePartKitAttributes(input: $input) { partKitAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "partKitId": 1 } ] } ``` ```json Response { "data": { "UpdatePartKitAttributes": { "partKitAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePartKitItemAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePartKitItemAttributes **mutation** `UpdatePartKitItemAttributes(input: [UpdatePartKitItemAttributeInput]!): UpdatePartKitItemAttributes` ## Arguments **`input`**: `[UpdatePartKitItemAttributeInput]!` (required) ## Returns `UpdatePartKitItemAttributes` **`partKitItemAttributes`**: `[PartKitItemAttribute]` ## Examples ```graphql Mutation mutation UpdatePartKitItemAttributes($input: [UpdatePartKitItemAttributeInput]!) { UpdatePartKitItemAttributes(input: $input) { partKitItemAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "partKitItemId": 1 } ] } ``` ```json Response { "data": { "UpdatePartKitItemAttributes": { "partKitItemAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePlanAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePlanAttributes **mutation** `UpdatePlanAttributes(input: [UpdatePlanAttributeInput]!): UpdatePlanAttributes` ## Arguments **`input`**: `[UpdatePlanAttributeInput]!` (required) ## Returns `UpdatePlanAttributes` **`planAttributes`**: `[PlanAttribute]` ## Examples ```graphql Mutation mutation UpdatePlanAttributes($input: [UpdatePlanAttributeInput]!) { UpdatePlanAttributes(input: $input) { planAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "planId": 1 } ] } ``` ```json Response { "data": { "UpdatePlanAttributes": { "planAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateProcedureAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateProcedureAttributes **mutation** `UpdateProcedureAttributes(input: [UpdateProcedureAttributeInput]!): UpdateProcedureAttributes` ## Arguments **`input`**: `[UpdateProcedureAttributeInput]!` (required) ## Returns `UpdateProcedureAttributes` **`procedureAttributes`**: `[ProcedureAttribute]` ## Examples ```graphql Mutation mutation UpdateProcedureAttributes($input: [UpdateProcedureAttributeInput]!) { UpdateProcedureAttributes(input: $input) { procedureAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "procedureId": 1 } ] } ``` ```json Response { "data": { "UpdateProcedureAttributes": { "procedureAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePurchaseOrderAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePurchaseOrderAttributes **mutation** `UpdatePurchaseOrderAttributes(input: [UpdatePurchaseOrderAttributeInput]!): UpdatePurchaseOrderAttributes` ## Arguments **`input`**: `[UpdatePurchaseOrderAttributeInput]!` (required) ## Returns `UpdatePurchaseOrderAttributes` **`purchaseOrderAttributes`**: `[PurchaseOrderAttribute]` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderAttributes($input: [UpdatePurchaseOrderAttributeInput]!) { UpdatePurchaseOrderAttributes(input: $input) { purchaseOrderAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "purchaseOrderId": 1 } ] } ``` ```json Response { "data": { "UpdatePurchaseOrderAttributes": { "purchaseOrderAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdatePurchaseOrderLineAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdatePurchaseOrderLineAttributes **mutation** `UpdatePurchaseOrderLineAttributes(input: [UpdatePurchaseOrderLineAttributeInput]!): UpdatePurchaseOrderLineAttributes` ## Arguments **`input`**: `[UpdatePurchaseOrderLineAttributeInput]!` (required) ## Returns `UpdatePurchaseOrderLineAttributes` **`purchaseOrderLineAttributes`**: `[PurchaseOrderLineAttribute]` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderLineAttributes($input: [UpdatePurchaseOrderLineAttributeInput]!) { UpdatePurchaseOrderLineAttributes(input: $input) { purchaseOrderLineAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "purchaseOrderLineId": 1 } ] } ``` ```json Response { "data": { "UpdatePurchaseOrderLineAttributes": { "purchaseOrderLineAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateReceiptAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateReceiptAttributes **mutation** `UpdateReceiptAttributes(input: [UpdateReceiptAttributeInput]!): UpdateReceiptAttributes` ## Arguments **`input`**: `[UpdateReceiptAttributeInput]!` (required) ## Returns `UpdateReceiptAttributes` **`receiptAttributes`**: `[ReceiptAttribute]` ## Examples ```graphql Mutation mutation UpdateReceiptAttributes($input: [UpdateReceiptAttributeInput]!) { UpdateReceiptAttributes(input: $input) { receiptAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "receiptId": 1 } ] } ``` ```json Response { "data": { "UpdateReceiptAttributes": { "receiptAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateRunAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateRunAttributes **mutation** `UpdateRunAttributes(input: [UpdateRunAttributeInput]!): UpdateRunAttributes` ## Arguments **`input`**: `[UpdateRunAttributeInput]!` (required) ## Returns `UpdateRunAttributes` **`runAttributes`**: `[RunAttribute]` ## Examples ```graphql Mutation mutation UpdateRunAttributes($input: [UpdateRunAttributeInput]!) { UpdateRunAttributes(input: $input) { runAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "runId": 1 } ] } ``` ```json Response { "data": { "UpdateRunAttributes": { "runAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateRunStepAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateRunStepAttributes **mutation** `UpdateRunStepAttributes(input: [UpdateRunStepAttributeInput]!): UpdateRunStepAttributes` ## Arguments **`input`**: `[UpdateRunStepAttributeInput]!` (required) ## Returns `UpdateRunStepAttributes` **`runStepAttributes`**: `[RunStepAttribute]` ## Examples ```graphql Mutation mutation UpdateRunStepAttributes($input: [UpdateRunStepAttributeInput]!) { UpdateRunStepAttributes(input: $input) { runStepAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "runStepId": 1 } ] } ``` ```json Response { "data": { "UpdateRunStepAttributes": { "runStepAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateStepAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateStepAttributes **mutation** `UpdateStepAttributes(input: [UpdateStepAttributeInput]!): UpdateStepAttributes` ## Arguments **`input`**: `[UpdateStepAttributeInput]!` (required) ## Returns `UpdateStepAttributes` **`stepAttributes`**: `[StepAttribute]` ## Examples ```graphql Mutation mutation UpdateStepAttributes($input: [UpdateStepAttributeInput]!) { UpdateStepAttributes(input: $input) { stepAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "stepId": 1 } ] } ``` ```json Response { "data": { "UpdateStepAttributes": { "stepAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # UpdateSupplierAttributes Source: https://docs.firstresonance.io/api-reference/mutations/UpdateSupplierAttributes **mutation** `UpdateSupplierAttributes(input: [UpdateSupplierAttributeInput]!): UpdateSupplierAttributes` ## Arguments **`input`**: `[UpdateSupplierAttributeInput]!` (required) ## Returns `UpdateSupplierAttributes` **`supplierAttributes`**: `[SupplierAttribute]` ## Examples ```graphql Mutation mutation UpdateSupplierAttributes($input: [UpdateSupplierAttributeInput]!) { UpdateSupplierAttributes(input: $input) { supplierAttributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": [ { "etag": "string", "key": "string", "supplierId": 1 } ] } ``` ```json Response { "data": { "UpdateSupplierAttributes": { "supplierAttributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ] } } } ``` # acceptAiTermsOfService Source: https://docs.firstresonance.io/api-reference/mutations/acceptAiTermsOfService Record this organization's acceptance of the AI Terms of Service. Admin-only, and rejected if the submitted version is not the one in force. **mutation** `acceptAiTermsOfService(bodySha256: String, identifier: String!): AcceptAiTermsOfService` ## Arguments **`bodySha256`**: `String` Digest of the text the caller displayed. Rejected if it does not match the terms in force, so an acceptance cannot cover unseen text. --- **`identifier`**: `String!` (required) The '-' being accepted. Must be the terms currently in force for this region; a superseded one is rejected. ## Returns `AcceptAiTermsOfService` **`acceptance`**: `AiTosAcceptance` ## Examples ```graphql Mutation mutation AcceptAiTermsOfService($identifier: String!) { acceptAiTermsOfService(identifier: $identifier) { acceptance { LastSessionId _created _etag _updated body bodySha256 } } } ``` ```json Variables { "identifier": "string" } ``` ```json Response { "data": { "acceptAiTermsOfService": { "acceptance": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "body": "string", "bodySha256": "string" } } } } ``` # acceptStepProposal Source: https://docs.firstresonance.io/api-reference/mutations/acceptStepProposal Applies a proposed revision to its step and marks the proposal accepted. **mutation** `acceptStepProposal(etag: String!, id: ID!): AcceptStepProposal` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `AcceptStepProposal` **`step`**: `Step` --- **`stepProposal`**: `StepProposal` ## Examples ```graphql Mutation mutation AcceptStepProposal($etag: String!, $id: ID!) { acceptStepProposal(etag: $etag, id: $id) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } stepProposal { LastSessionId _created _etag _updated acceptedEtag applicationPreview { applicable conflictMessage content slateContent title } } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "acceptStepProposal": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 }, "stepProposal": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "applicable": true, "conflictMessage": "string", "content": "string", "slateContent": "value", "title": "string" } } } } } ``` # addAssetToItem Source: https://docs.firstresonance.io/api-reference/mutations/addAssetToItem Adds an existing file attachment as an asset to an item. **mutation** `addAssetToItem(input: AssetToItemInput!): AddAssetToItem` ## Arguments **`input`**: `AssetToItemInput!` (required) ## Returns `AddAssetToItem` **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` ## Examples ```graphql Mutation mutation AddAssetToItem($input: AssetToItemInput!) { addAssetToItem(input: $input) { entity { Updated assets { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } comments { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } fileAttachments { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } id } entityId fileAttachmentId } } ``` ```json Variables { "input": { "entityId": "id", "fileAttachmentId": "id" } } ``` ```json Response { "data": { "addAssetToItem": { "entity": { "Updated": "value", "assets": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ], "comments": [ { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } ], "fileAttachments": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "id": 1.5 }, "entityId": 1, "fileAttachmentId": 1 } } } ``` # addFileAttachmentToItem Source: https://docs.firstresonance.io/api-reference/mutations/addFileAttachmentToItem Adds an existing file attachment to an item via entities_file_attachments. **mutation** `addFileAttachmentToItem(input: FileAttachmentToItemInput!): AddFileAttachmentToItem` ## Arguments **`input`**: `FileAttachmentToItemInput!` (required) ## Returns `AddFileAttachmentToItem` **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` ## Examples ```graphql Mutation mutation AddFileAttachmentToItem($input: FileAttachmentToItemInput!) { addFileAttachmentToItem(input: $input) { entity { Updated assets { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } comments { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } fileAttachments { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } id } entityId fileAttachmentId } } ``` ```json Variables { "input": { "entityId": "id", "fileAttachmentId": "id" } } ``` ```json Response { "data": { "addFileAttachmentToItem": { "entity": { "Updated": "value", "assets": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ], "comments": [ { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } ], "fileAttachments": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "id": 1.5 }, "entityId": 1, "fileAttachmentId": 1 } } } ``` # addHeaderToWebhookReceiver Source: https://docs.firstresonance.io/api-reference/mutations/addHeaderToWebhookReceiver Adds a header to a webhook receiver configuration. **mutation** `addHeaderToWebhookReceiver(input: WebhookReceiverHeaderInput): AddHeaderToWebhookReceiver` ## Arguments **`input`**: `WebhookReceiverHeaderInput` ## Returns `AddHeaderToWebhookReceiver` **`webhookReceiver`**: `WebhookReceiver` ## Examples ```graphql Mutation mutation AddHeaderToWebhookReceiver { addHeaderToWebhookReceiver { webhookReceiver { LastSessionId _HeadersCount _SubscriptionsCount _created _etag _updated } } } ``` ```json Response { "data": { "addHeaderToWebhookReceiver": { "webhookReceiver": { "LastSessionId": "string", "_HeadersCount": 1, "_SubscriptionsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # addInputToPlan Source: https://docs.firstresonance.io/api-reference/mutations/addInputToPlan **mutation** `addInputToPlan(input: AddInputToPlanInput!): AddInputToPlan` ## Arguments **`input`**: `AddInputToPlanInput!` (required) ## Returns `AddInputToPlan` **`planInput`**: `PlanInput` ## Examples ```graphql Mutation mutation AddInputToPlan($input: AddInputToPlanInput!) { addInputToPlan(input: $input) { planInput { Deleted LastSessionId _PlanItemsCount _created _etag _updated } } } ``` ```json Variables { "input": { "dueDate": "value", "partId": "id", "planId": "id", "quantity": 1 } } ``` ```json Response { "data": { "addInputToPlan": { "planInput": { "Deleted": true, "LastSessionId": "string", "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # addInventoriesToReceipt Source: https://docs.firstresonance.io/api-reference/mutations/addInventoriesToReceipt Add multiple inventories to receipt. **mutation** `addInventoriesToReceipt(input: [AddInventoryToReceiptInput]): AddInventoriesToReceipt` > Deprecated: Use AddItemsToReceipt instead, which allows for both part and non-part items to be added to a receipt. ## Arguments **`input`**: `[AddInventoryToReceiptInput]` ## Returns `AddInventoriesToReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation AddInventoriesToReceipt { addInventoriesToReceipt { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "addInventoriesToReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # addInventoryToPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/addInventoryToPurchaseOrderLine Adds inventory to a purchase order line item, linking received parts to the order. **mutation** `addInventoryToPurchaseOrderLine(input: PurchaseOrderLineToInventoryInput): AddInventoryToPurchaseOrderLine` ## Arguments **`input`**: `PurchaseOrderLineToInventoryInput` ## Returns `AddInventoryToPurchaseOrderLine` **`purchaseOrderLine`**: `PurchaseOrderLine` ## Examples ```graphql Mutation mutation AddInventoryToPurchaseOrderLine { addInventoryToPurchaseOrderLine { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "addInventoryToPurchaseOrderLine": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # addInventoryToReceipt Source: https://docs.firstresonance.io/api-reference/mutations/addInventoryToReceipt Add a quantity of inventory to receipt. **mutation** `addInventoryToReceipt(input: AddInventoryToReceiptInput): AddInventoryToReceipt` > Deprecated: Use AddItemsToReceipt instead, which allows for multiple items to be added. ## Arguments **`input`**: `AddInventoryToReceiptInput` ## Returns `AddInventoryToReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation AddInventoryToReceipt { addInventoryToReceipt { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "addInventoryToReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # addItemsToReceipt Source: https://docs.firstresonance.io/api-reference/mutations/addItemsToReceipt Adds items to a receipt. **mutation** `addItemsToReceipt(input: [AddItemToReceiptInput]): AddItemsToReceipt` ## Arguments **`input`**: `[AddItemToReceiptInput]` ## Returns `AddItemsToReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation AddItemsToReceipt { addItemsToReceipt { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "addItemsToReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # addLabelToItem Source: https://docs.firstresonance.io/api-reference/mutations/addLabelToItem Adds a label to an item. **mutation** `addLabelToItem(input: LabelToItemInput!): AddLabelToItem` ## Arguments **`input`**: `LabelToItemInput!` (required) ## Returns `AddLabelToItem` **`entityId`**: `Int` --- **`labelId`**: `Int` ## Examples ```graphql Mutation mutation AddLabelToItem($input: LabelToItemInput!) { addLabelToItem(input: $input) { entityId labelId } } ``` ```json Variables { "input": { "entityId": 1, "labelId": 1 } } ``` ```json Response { "data": { "addLabelToItem": { "entityId": 1, "labelId": 1 } } } ``` # addLabelToProcedureFamily Source: https://docs.firstresonance.io/api-reference/mutations/addLabelToProcedureFamily Adds a label to a procedure family. Labels can be used to organize and categorize procedures. **mutation** `addLabelToProcedureFamily(input: LabelToProcedureFamilyInput!): AddLabelToProcedureFamily` ## Arguments **`input`**: `LabelToProcedureFamilyInput!` (required) ## Returns `AddLabelToProcedureFamily` **`familyId`**: `Int` --- **`labelId`**: `Int` ## Examples ```graphql Mutation mutation AddLabelToProcedureFamily($input: LabelToProcedureFamilyInput!) { addLabelToProcedureFamily(input: $input) { familyId labelId } } ``` ```json Variables { "input": { "familyId": 1, "labelId": 1 } } ``` ```json Response { "data": { "addLabelToProcedureFamily": { "familyId": 1, "labelId": 1 } } } ``` # addOauthRedirectUri Source: https://docs.firstresonance.io/api-reference/mutations/addOauthRedirectUri Add a callback URL or allowed origin to an OAuth app. **mutation** `addOauthRedirectUri(oauthAppId: Int!, uri: String!, uriType: String!): AddOAuthRedirectUri` ## Arguments **`oauthAppId`**: `Int!` (required) --- **`uri`**: `String!` (required) --- **`uriType`**: `String!` (required) ## Returns `AddOAuthRedirectUri` **`redirectUri`**: `OAuthRedirectUriObject` ## Examples ```graphql Mutation mutation AddOauthRedirectUri($oauthAppId: Int!, $uri: String!, $uriType: String!) { addOauthRedirectUri(oauthAppId: $oauthAppId, uri: $uri, uriType: $uriType) { redirectUri { _created createdById id uri uriType } } } ``` ```json Variables { "oauthAppId": 1, "uri": "string", "uriType": "string" } ``` ```json Response { "data": { "addOauthRedirectUri": { "redirectUri": { "_created": "value", "createdById": 1, "id": 1, "uri": "string", "uriType": "string" } } } } ``` # addPartInventoryToRunStep Source: https://docs.firstresonance.io/api-reference/mutations/addPartInventoryToRunStep Adds a specific part from inventory to a run step, consuming it for the build. **mutation** `addPartInventoryToRunStep(input: AddPartInventoryToRunStepInput!): AddPartInventoryToRunStep` ## Arguments **`input`**: `AddPartInventoryToRunStepInput!` (required) ## Returns `AddPartInventoryToRunStep` **`runStep`**: `RunStep` ## Examples ```graphql Mutation mutation AddPartInventoryToRunStep($input: AddPartInventoryToRunStepInput!) { addPartInventoryToRunStep(input: $input) { runStep { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "etag": "string", "partInventoryId": "id", "runStepId": "id" } } ``` ```json Response { "data": { "addPartInventoryToRunStep": { "runStep": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } } ``` # addPartsToKitFromMbom Source: https://docs.firstresonance.io/api-reference/mutations/addPartsToKitFromMbom Adds parts to a kit based on a manufacturing bill of materials (mBOM). **mutation** `addPartsToKitFromMbom(input: AddPartsToKitFromMbomInput!): AddPartsToKitFromMbom` ## Arguments **`input`**: `AddPartsToKitFromMbomInput!` (required) ## Returns `AddPartsToKitFromMbom` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation AddPartsToKitFromMbom($input: AddPartsToKitFromMbomInput!) { addPartsToKitFromMbom(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": { "etag": "string", "partId": 1, "partKitId": 1 } } ``` ```json Response { "data": { "addPartsToKitFromMbom": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # addPlanItemToPlan Source: https://docs.firstresonance.io/api-reference/mutations/addPlanItemToPlan Adds an item to a plan. Plans are used for demand forecasting and production scheduling. **mutation** `addPlanItemToPlan(input: PlanItemToPlanInput): AddPlanItemToPlan` ## Arguments **`input`**: `PlanItemToPlanInput` ## Returns `AddPlanItemToPlan` **`plan`**: `Plan` ## Examples ```graphql Mutation mutation AddPlanItemToPlan { addPlanItemToPlan { plan { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "addPlanItemToPlan": { "plan": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # addRequirementToItem Source: https://docs.firstresonance.io/api-reference/mutations/addRequirementToItem Adds a requirement to an item. **mutation** `addRequirementToItem(input: RequirementToItemInput!): AddRequirementToItem` ## Arguments **`input`**: `RequirementToItemInput!` (required) ## Returns `AddRequirementToItem` **`entityId`**: `Int` --- **`requirementId`**: `Int` ## Examples ```graphql Mutation mutation AddRequirementToItem($input: RequirementToItemInput!) { addRequirementToItem(input: $input) { entityId requirementId } } ``` ```json Variables { "input": { "entityId": 1, "requirementId": 1 } } ``` ```json Response { "data": { "addRequirementToItem": { "entityId": 1, "requirementId": 1 } } } ``` # addResultToPlanItem Source: https://docs.firstresonance.io/api-reference/mutations/addResultToPlanItem Adds a result to a plan item. This could be a purchase order or a run. **mutation** `addResultToPlanItem(input: ResultToPlanItemInput): AddResultToPlanItem` ## Arguments **`input`**: `ResultToPlanItemInput` ## Returns `AddResultToPlanItem` **`planItem`**: `PlanItem` ## Examples ```graphql Mutation mutation AddResultToPlanItem { addResultToPlanItem { planItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } } ``` ```json Response { "data": { "addResultToPlanItem": { "planItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } } } ``` # addSubtypeToPart Source: https://docs.firstresonance.io/api-reference/mutations/addSubtypeToPart Adds a subtype to a part. **mutation** `addSubtypeToPart(input: PartSubtypeToPartInput): AddSubtypeToPart` ## Arguments **`input`**: `PartSubtypeToPartInput` ## Returns `AddSubtypeToPart` **`part`**: `Part` ## Examples ```graphql Mutation mutation AddSubtypeToPart { addSubtypeToPart { part { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } } ``` ```json Response { "data": { "addSubtypeToPart": { "part": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } } } } ``` # addUserToTeam Source: https://docs.firstresonance.io/api-reference/mutations/addUserToTeam Adds a user to a team. **mutation** `addUserToTeam(input: TeamToUserInput!): AddUserToTeam` ## Arguments **`input`**: `TeamToUserInput!` (required) ## Returns `AddUserToTeam` **`teamId`**: `Int` --- **`userId`**: `Int` ## Examples ```graphql Mutation mutation AddUserToTeam($input: TeamToUserInput!) { addUserToTeam(input: $input) { teamId userId } } ``` ```json Variables { "input": { "teamId": 1, "userId": 1 } } ``` ```json Response { "data": { "addUserToTeam": { "teamId": 1, "userId": 1 } } } ``` # applyMbomChangeOrderLines Source: https://docs.firstresonance.io/api-reference/mutations/applyMbomChangeOrderLines Applies lines: executes each line's resolutions and re-points its inventory's origin mBOM. One line or many, always all or nothing in one transaction. **mutation** `applyMbomChangeOrderLines(input: MbomChangeOrderLinesInput!): ApplyMbomChangeOrderLines` ## Arguments **`input`**: `MbomChangeOrderLinesInput!` (required) ## Returns `ApplyMbomChangeOrderLines` **`mbomChanges`**: `[MbomChangeOrderLine]` ## Examples ```graphql Mutation mutation ApplyMbomChangeOrderLines($input: MbomChangeOrderLinesInput!) { applyMbomChangeOrderLines(input: $input) { mbomChanges { LastSessionId _created _etag _updated appliedAt appliedBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "sources": [ { "etag": "string", "id": 1 } ] } } ``` ```json Response { "data": { "applyMbomChangeOrderLines": { "mbomChanges": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "appliedAt": "value", "appliedBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } ] } } } ``` # archiveRun Source: https://docs.firstresonance.io/api-reference/mutations/archiveRun Archives a completed or canceled run, removing it from the main view. **mutation** `archiveRun(input: ArchiveRunInput!): ArchiveRun` ## Arguments **`input`**: `ArchiveRunInput!` (required) ## Returns `ArchiveRun` **`run`**: `Run` ## Examples ```graphql Mutation mutation ArchiveRun($input: ArchiveRunInput!) { archiveRun(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "archived": true, "etag": "string", "id": "id" } } ``` ```json Response { "data": { "archiveRun": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # assignReferenceDesignatorToRunStep Source: https://docs.firstresonance.io/api-reference/mutations/assignReferenceDesignatorToRunStep Assigns a reference designator to a run step on a cut run, diverging the shadow from its mBOM origin so it survives reconcile. **mutation** `assignReferenceDesignatorToRunStep(input: AssignReferenceDesignatorToRunStepInput!): AssignReferenceDesignatorToRunStep` ## Arguments **`input`**: `AssignReferenceDesignatorToRunStepInput!` (required) ## Returns `AssignReferenceDesignatorToRunStep` **`runReferenceDesignatorAssignment`**: `RunReferenceDesignatorAssignment` ## Examples ```graphql Mutation mutation AssignReferenceDesignatorToRunStep($input: AssignReferenceDesignatorToRunStepInput!) { assignReferenceDesignatorToRunStep(input: $input) { runReferenceDesignatorAssignment { Deleted LastSessionId _created _etag _updated buildRequirementId } } } ``` ```json Variables { "input": { "buildRequirementReferenceDesignatorId": 1, "runStepId": 1 } } ``` ```json Response { "data": { "assignReferenceDesignatorToRunStep": { "runReferenceDesignatorAssignment": { "Deleted": true, "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirementId": 1 } } } } ``` # assignRunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/assignRunStepBuildRequirement Maps an existing aBOM build requirement to a run step, diverging it from its procedure origin. **mutation** `assignRunStepBuildRequirement(input: AssignRunStepBuildRequirementInput!): AssignRunStepBuildRequirement` ## Arguments **`input`**: `AssignRunStepBuildRequirementInput!` (required) ## Returns `AssignRunStepBuildRequirement` **`runStepBuildRequirement`**: `RunStepBuildRequirementMaterialized` ## Examples ```graphql Mutation mutation AssignRunStepBuildRequirement($input: AssignRunStepBuildRequirementInput!) { assignRunStepBuildRequirement(input: $input) { runStepBuildRequirement { Deleted LastSessionId _AbomInstallationsCount _AssignedAndInstalledReferenceDesignatorsCount _AssignedReferenceDesignatorsCount _InstalledReferenceDesignatorsCount } } } ``` ```json Variables { "input": { "buildRequirementId": 1, "quantity": 1.5, "runStepId": 1 } } ``` ```json Response { "data": { "assignRunStepBuildRequirement": { "runStepBuildRequirement": { "Deleted": true, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AssignedAndInstalledReferenceDesignatorsCount": 1.5, "_AssignedReferenceDesignatorsCount": 1, "_InstalledReferenceDesignatorsCount": 1.5 } } } } ``` # attachPermissionGroupToRole Source: https://docs.firstresonance.io/api-reference/mutations/attachPermissionGroupToRole Attaches a permission group to a role. **mutation** `attachPermissionGroupToRole(input: PermissionGroupToRoleInput!): AttachPermissionGroupToRole` ## Arguments **`input`**: `PermissionGroupToRoleInput!` (required) ## Returns `AttachPermissionGroupToRole` **`role`**: `Role` ## Examples ```graphql Mutation mutation AttachPermissionGroupToRole($input: PermissionGroupToRoleInput!) { attachPermissionGroupToRole(input: $input) { role { LastSessionId _IssueApprovalRequestsCount _IssueApprovalsCount _IssueDispositionTypeRolesCount _PermissionGroupRolesCount _PermissionGroupsCount } } } ``` ```json Variables { "input": { "permissionGroupId": 1, "roleId": 1 } } ``` ```json Response { "data": { "attachPermissionGroupToRole": { "role": { "LastSessionId": "string", "_IssueApprovalRequestsCount": 1, "_IssueApprovalsCount": 1, "_IssueDispositionTypeRolesCount": 1, "_PermissionGroupRolesCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # attachRoleToTeam Source: https://docs.firstresonance.io/api-reference/mutations/attachRoleToTeam Assigns a role to a team, granting all members of the team the associated permissions. **mutation** `attachRoleToTeam(input: TeamToRoleInput!): AttachRoleToTeam` ## Arguments **`input`**: `TeamToRoleInput!` (required) ## Returns `AttachRoleToTeam` **`roleId`**: `Int` --- **`teamId`**: `Int` ## Examples ```graphql Mutation mutation AttachRoleToTeam($input: TeamToRoleInput!) { attachRoleToTeam(input: $input) { roleId teamId } } ``` ```json Variables { "input": { "roleId": 1, "teamId": 1 } } ``` ```json Response { "data": { "attachRoleToTeam": { "roleId": 1, "teamId": 1 } } } ``` # attachRoleToUser Source: https://docs.firstresonance.io/api-reference/mutations/attachRoleToUser Assigns a role to a user, granting them a set of permissions. **mutation** `attachRoleToUser(input: RoleToUserInput!): AttachRoleToUser` ## Arguments **`input`**: `RoleToUserInput!` (required) ## Returns `AttachRoleToUser` **`roleId`**: `Int` --- **`userId`**: `Int` ## Examples ```graphql Mutation mutation AttachRoleToUser($input: RoleToUserInput!) { attachRoleToUser(input: $input) { roleId userId } } ``` ```json Variables { "input": { "roleId": 1, "userId": "id" } } ``` ```json Response { "data": { "attachRoleToUser": { "roleId": 1, "userId": 1 } } } ``` # batchRunSteps Source: https://docs.firstresonance.io/api-reference/mutations/batchRunSteps Groups multiple run steps into a batch for simultaneous execution. **mutation** `batchRunSteps(input: [BatchRunStepsInput]): BatchRunSteps` ## Arguments **`input`**: `[BatchRunStepsInput]` ## Returns `BatchRunSteps` **`runSteps`**: `[RunStep]` ## Examples ```graphql Mutation mutation BatchRunSteps { batchRunSteps { runSteps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Response { "data": { "batchRunSteps": { "runSteps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } ] } } } ``` # cancelChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/cancelChangeOrder Cancels a change order, canceling every workflow's in-flight changes under it. **mutation** `cancelChangeOrder(input: ChangeOrderStatusTransitionInput!): CancelChangeOrder` ## Arguments **`input`**: `ChangeOrderStatusTransitionInput!` (required) ## Returns `CancelChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation CancelChangeOrder($input: ChangeOrderStatusTransitionInput!) { cancelChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "cancelChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # cancelPickRun Source: https://docs.firstresonance.io/api-reference/mutations/cancelPickRun Abandons a pick-run, releasing the stock it still holds; fulfilled stops are left untouched. **mutation** `cancelPickRun(input: CancelPickRunInput!): CancelPickRun` ## Arguments **`input`**: `CancelPickRunInput!` (required) ## Returns `CancelPickRun` **`pickRun`**: `PickRun` ## Examples ```graphql Mutation mutation CancelPickRun($input: CancelPickRunInput!) { cancelPickRun(input: $input) { pickRun { Created Etag LastSessionId Updated _KitsCount _StopsCount } } } ``` ```json Variables { "input": { "etag": "string", "pickRunId": "id" } } ``` ```json Response { "data": { "cancelPickRun": { "pickRun": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_KitsCount": 1, "_StopsCount": 1 } } } } ``` # cancelRun Source: https://docs.firstresonance.io/api-reference/mutations/cancelRun Cancels a run that is in progress. **mutation** `cancelRun(input: CancelRunInput!): CancelRun` ## Arguments **`input`**: `CancelRunInput!` (required) ## Returns `CancelRun` **`run`**: `Run` ## Examples ```graphql Mutation mutation CancelRun($input: CancelRunInput!) { cancelRun(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "cancelRun": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # cancelRunStepRedline Source: https://docs.firstresonance.io/api-reference/mutations/cancelRunStepRedline Cancels a redline on a run step. Redlines are proposed changes to a procedure made during a run. **mutation** `cancelRunStepRedline(etag: String!, id: ID!): CancelRunStepRedline` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `CancelRunStepRedline` **`runStep`**: `RunStep` ## Examples ```graphql Mutation mutation CancelRunStepRedline($etag: String!, $id: ID!) { cancelRunStepRedline(etag: $etag, id: $id) { runStep { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "cancelRunStepRedline": { "runStep": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } } ``` # checkIn Source: https://docs.firstresonance.io/api-reference/mutations/checkIn Checks into a run step, starting a time tracking session for a user. **mutation** `checkIn(input: SessionEventInput!): CheckIn` ## Arguments **`input`**: `SessionEventInput!` (required) ## Returns `CheckIn` **`checkInEvent`**: `SessionEvent` ## Examples ```graphql Mutation mutation CheckIn($input: SessionEventInput!) { checkIn(input: $input) { checkInEvent { Created LastSessionId Updated checkIn checkOut createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "runStepId": "id" } } ``` ```json Response { "data": { "checkIn": { "checkInEvent": { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # checkOut Source: https://docs.firstresonance.io/api-reference/mutations/checkOut Checks out of a run step, stopping the time tracking session for a user. **mutation** `checkOut(input: SessionEventInput!): CheckOut` ## Arguments **`input`**: `SessionEventInput!` (required) ## Returns `CheckOut` **`checkOutEvent`**: `SessionEvent` ## Examples ```graphql Mutation mutation CheckOut($input: SessionEventInput!) { checkOut(input: $input) { checkOutEvent { Created LastSessionId Updated checkIn checkOut createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "runStepId": "id" } } ``` ```json Response { "data": { "checkOut": { "checkOutEvent": { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # checkSsoConnectionStatus Source: https://docs.firstresonance.io/api-reference/mutations/checkSsoConnectionStatus Checks whether the customer has completed SSO setup. **mutation** `checkSsoConnectionStatus: CheckSSOConnectionStatus` ## Returns `CheckSSOConnectionStatus` **`status`**: `SSOConnectionStatus` ## Examples ```graphql Mutation mutation CheckSsoConnectionStatus { checkSsoConnectionStatus { status { configured connectionId providerName providerType } } } ``` ```json Response { "data": { "checkSsoConnectionStatus": { "status": { "configured": true, "connectionId": "string", "providerName": "string", "providerType": "string" } } } } ``` # clearStepProposal Source: https://docs.firstresonance.io/api-reference/mutations/clearStepProposal Removes one proposed revision from the list, leaving the record of how it ended. Refuses one still awaiting a decision. **mutation** `clearStepProposal(etag: String!, id: ID!): ClearStepProposal` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `ClearStepProposal` **`stepProposal`**: `StepProposal` ## Examples ```graphql Mutation mutation ClearStepProposal($etag: String!, $id: ID!) { clearStepProposal(etag: $etag, id: $id) { stepProposal { LastSessionId _created _etag _updated acceptedEtag applicationPreview { applicable conflictMessage content slateContent title } } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "clearStepProposal": { "stepProposal": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "applicable": true, "conflictMessage": "string", "content": "string", "slateContent": "value", "title": "string" } } } } } ``` # clearStepProposals Source: https://docs.firstresonance.io/api-reference/mutations/clearStepProposals Removes every proposed revision on a procedure that has been decided or outrun by its step, and reports how many were removed. **mutation** `clearStepProposals(procedureId: ID!): ClearStepProposals` ## Arguments **`procedureId`**: `ID!` (required) ## Returns `ClearStepProposals` **`clearedCount`**: `Int` ## Examples ```graphql Mutation mutation ClearStepProposals($procedureId: ID!) { clearStepProposals(procedureId: $procedureId) { clearedCount } } ``` ```json Variables { "procedureId": "id" } ``` ```json Response { "data": { "clearStepProposals": { "clearedCount": 1 } } } ``` # cloneProcedure Source: https://docs.firstresonance.io/api-reference/mutations/cloneProcedure Creates a copy of an existing procedure, including its steps and content. **mutation** `cloneProcedure(etag: String!, procedureId: ID!): CloneProcedure` ## Arguments **`etag`**: `String!` (required) --- **`procedureId`**: `ID!` (required) ## Returns `CloneProcedure` **`procedure`**: `Procedure` ## Examples ```graphql Mutation mutation CloneProcedure($etag: String!, $procedureId: ID!) { cloneProcedure(etag: $etag, procedureId: $procedureId) { procedure { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "etag": "string", "procedureId": "id" } ``` ```json Response { "data": { "cloneProcedure": { "procedure": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # completeChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/completeChangeOrder Closes a change order whose lines have all closed, with at least one of them applied. It writes the status only, so it never closes a line on the author's behalf. **mutation** `completeChangeOrder(input: ChangeOrderStatusTransitionInput!): CompleteChangeOrder` ## Arguments **`input`**: `ChangeOrderStatusTransitionInput!` (required) ## Returns `CompleteChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation CompleteChangeOrder($input: ChangeOrderStatusTransitionInput!) { completeChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "completeChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # confirmMbomChangeOrderLineDiffResolution Source: https://docs.firstresonance.io/api-reference/mutations/confirmMbomChangeOrderLineDiffResolution Confirms mBOM change diff resolutions: one row or many, signed off or left open, and optionally pushed onto every line sharing each diff. Each row validates the resolution against its own legal set. **mutation** `confirmMbomChangeOrderLineDiffResolution(input: ConfirmMbomChangeOrderLineDiffResolutionInput!): ConfirmMbomChangeOrderLineDiffResolution` ## Arguments **`input`**: `ConfirmMbomChangeOrderLineDiffResolutionInput!` (required) ## Returns `ConfirmMbomChangeOrderLineDiffResolution` **`diffs`**: `[MbomChangeOrderLineDiff]` ## Examples ```graphql Mutation mutation ConfirmMbomChangeOrderLineDiffResolution($input: ConfirmMbomChangeOrderLineDiffResolutionInput!) { confirmMbomChangeOrderLineDiffResolution(input: $input) { diffs { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "sources": [ { "etag": "string", "id": 1, "resolutionType": "ADD_NEW_BUILD_REQUIREMENT" } ] } } ``` ```json Response { "data": { "confirmMbomChangeOrderLineDiffResolution": { "diffs": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } ] } } } ``` # convertResultsFromPlanItem Source: https://docs.firstresonance.io/api-reference/mutations/convertResultsFromPlanItem Converts the results of a plan item, for example from a purchase suggestion to a purchase order. **mutation** `convertResultsFromPlanItem(input: ConvertResultsFromPlanItemInput): ConvertResultsFromPlanItem` ## Arguments **`input`**: `ConvertResultsFromPlanItemInput` ## Returns `ConvertResultsFromPlanItem` **`planItem`**: `PlanItem` ## Examples ```graphql Mutation mutation ConvertResultsFromPlanItem { convertResultsFromPlanItem { planItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } } ``` ```json Response { "data": { "convertResultsFromPlanItem": { "planItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } } } ``` # convertResultsFromPlanItems Source: https://docs.firstresonance.io/api-reference/mutations/convertResultsFromPlanItems Converts the results of multiple plan items. **mutation** `convertResultsFromPlanItems(input: ConvertResultsFromPlanItemsInput): ConvertResultsFromPlanItems` ## Arguments **`input`**: `ConvertResultsFromPlanItemsInput` ## Returns `ConvertResultsFromPlanItems` **`planItems`**: `[PlanItem]` ## Examples ```graphql Mutation mutation ConvertResultsFromPlanItems { convertResultsFromPlanItems { planItems { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } } ``` ```json Response { "data": { "convertResultsFromPlanItems": { "planItems": [ { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } ] } } } ``` # copyField Source: https://docs.firstresonance.io/api-reference/mutations/copyField Copies a field definition. **mutation** `copyField(input: CopyFieldInput!): CopyField` ## Arguments **`input`**: `CopyFieldInput!` (required) ## Returns `CopyField` **`stepField`**: `StepField` ## Examples ```graphql Mutation mutation CopyField($input: CopyFieldInput!) { copyField(input: $input) { stepField { LastSessionId _ValidationsCount _created _etag _updated allowNotApplicable } } } ``` ```json Variables { "input": { "fieldId": "id", "stepId": "id" } } ``` ```json Response { "data": { "copyField": { "stepField": { "LastSessionId": "string", "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allowNotApplicable": true } } } } ``` # copyPurchaseOrder Source: https://docs.firstresonance.io/api-reference/mutations/copyPurchaseOrder Copies a purchase order. **mutation** `copyPurchaseOrder(id: ID!): CopyPurchaseOrder` ## Arguments **`id`**: `ID!` (required) ## Returns `CopyPurchaseOrder` **`purchaseOrder`**: `PurchaseOrder` ## Examples ```graphql Mutation mutation CopyPurchaseOrder($id: ID!) { copyPurchaseOrder(id: $id) { purchaseOrder { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalLevelsCount _ApprovalRequestsCount _ApprovalsCount _AssigneesCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "copyPurchaseOrder": { "purchaseOrder": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalLevelsCount": 1, "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1 } } } } ``` # copyPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/copyPurchaseOrderLine Copies a line item from a purchase order. **mutation** `copyPurchaseOrderLine(input: CopyPurchaseOrderLineInput!): CopyPurchaseOrderLine` ## Arguments **`input`**: `CopyPurchaseOrderLineInput!` (required) ## Returns `CopyPurchaseOrderLine` **`purchaseOrderLine`**: `PurchaseOrderLine` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` ## Examples ```graphql Mutation mutation CopyPurchaseOrderLine($input: CopyPurchaseOrderLineInput!) { copyPurchaseOrderLine(input: $input) { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } reorderedPurchaseOrderLines { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "purchaseOrderLineId": "id" } } ``` ```json Response { "data": { "copyPurchaseOrderLine": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 }, "reorderedPurchaseOrderLines": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } ] } } } ``` # copyStandardStep Source: https://docs.firstresonance.io/api-reference/mutations/copyStandardStep Creates a copy of a standard step, which can then be modified and used in procedures. **mutation** `copyStandardStep(input: CopyStandardStepInput!): CopyStandardStep` ## Arguments **`input`**: `CopyStandardStepInput!` (required) ## Returns `CopyStandardStep` **`step`**: `Step` ## Examples ```graphql Mutation mutation CopyStandardStep($input: CopyStandardStepInput!) { copyStandardStep(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "stepId": "id" } } ``` ```json Response { "data": { "copyStandardStep": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # copyStep Source: https://docs.firstresonance.io/api-reference/mutations/copyStep Copies a step, which can then be added to a procedure. **mutation** `copyStep(input: CopyStepInput!): CopyStep` ## Arguments **`input`**: `CopyStepInput!` (required) ## Returns `CopyStep` **`step`**: `Step` ## Examples ```graphql Mutation mutation CopyStep($input: CopyStepInput!) { copyStep(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "stepId": "id" } } ``` ```json Response { "data": { "copyStep": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # copyStepToRun Source: https://docs.firstresonance.io/api-reference/mutations/copyStepToRun Copies a step from a procedure to a specific run. This is useful for making one-off changes to a run without modifying the underlying procedure. **mutation** `copyStepToRun(input: CopyStepToRunInput!): CopyStepToRun` ## Arguments **`input`**: `CopyStepToRunInput!` (required) ## Returns `CopyStepToRun` **`reorderedRunSteps`**: `[RunStep]` --- **`runStep`**: `RunStep` ## Examples ```graphql Mutation mutation CopyStepToRun($input: CopyStepToRunInput!) { copyStepToRun(input: $input) { reorderedRunSteps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } runStep { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "runId": "id", "stepId": "id" } } ``` ```json Response { "data": { "copyStepToRun": { "reorderedRunSteps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } ], "runStep": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } } ``` # createAbomForPartInventory Source: https://docs.firstresonance.io/api-reference/mutations/createAbomForPartInventory Creates an as-built bill of materials (aBOM) for a specific part in inventory. This represents the actual components used to build that part instance. **mutation** `createAbomForPartInventory(etag: String!, id: Int!): CreateABomForPartInventory` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) ## Returns `CreateABomForPartInventory` **`partInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation CreateAbomForPartInventory($etag: String!, $id: Int!) { createAbomForPartInventory(etag: $etag, id: $id) { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "etag": "string", "id": 1 } ``` ```json Response { "data": { "createAbomForPartInventory": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createAbomInstallation Source: https://docs.firstresonance.io/api-reference/mutations/createAbomInstallation Records the installation of a component onto an as-built bill of materials (aBOM). **mutation** `createAbomInstallation(input: CreateABomInstallationInput): CreateABomInstallation` ## Arguments **`input`**: `CreateABomInstallationInput` ## Returns `CreateABomInstallation` **`abomInstallation`**: `ABomInstallation` --- **`splitInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation CreateAbomInstallation { createAbomInstallation { abomInstallation { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } splitInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "createAbomInstallation": { "abomInstallation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 }, "splitInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createApiKey Source: https://docs.firstresonance.io/api-reference/mutations/createApiKey Creates a new API key for a user or an application. API keys are used to authenticate with the ION API and are required to obtain access tokens for performing operations. **mutation** `createApiKey(description: String, name: String): CreateAPIKey` ## Arguments **`description`**: `String` --- **`name`**: `String` ## Returns `CreateAPIKey` **`apikey`**: `APIKeyObject` ## Examples ```graphql Mutation mutation CreateApiKey { createApiKey { apikey { _created _etag _updated clientId clientSecret createdByApiClient { id name } } } } ``` ```json Response { "data": { "createApiKey": { "apikey": { "_created": "value", "_etag": "string", "_updated": "value", "clientId": "string", "clientSecret": "string", "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/createApprovalLevel **mutation** `createApprovalLevel(input: CreateApprovalLevelInput!): CreateApprovalLevel` ## Arguments **`input`**: `CreateApprovalLevelInput!` (required) ## Returns `CreateApprovalLevel` **`approvalLevel`**: `ApprovalLevel` ## Examples ```graphql Mutation mutation CreateApprovalLevel($input: CreateApprovalLevelInput!) { createApprovalLevel(input: $input) { approvalLevel { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createApprovalLevel": { "approvalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createAsset Source: https://docs.firstresonance.io/api-reference/mutations/createAsset Creates an asset, which can be a file or other resource. **mutation** `createAsset(input: CreateFileAttachmentInput!): CreateAsset` ## Arguments **`input`**: `CreateFileAttachmentInput!` (required) ## Returns `CreateAsset` **`fileAttachment`**: `FileAttachment` --- **`uploadUrl`**: `String` ## Examples ```graphql Mutation mutation CreateAsset($input: CreateFileAttachmentInput!) { createAsset(input: $input) { fileAttachment { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } uploadUrl } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createAsset": { "fileAttachment": { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" }, "uploadUrl": "string" } } } ``` # createBarcodeLabel Source: https://docs.firstresonance.io/api-reference/mutations/createBarcodeLabel **mutation** `createBarcodeLabel(input: CreateBarcodeLabelInput!): CreateBarcodeLabel` ## Arguments **`input`**: `CreateBarcodeLabelInput!` (required) ## Returns `CreateBarcodeLabel` **`barcodeLabel`**: `BarcodeLabel` ## Examples ```graphql Mutation mutation CreateBarcodeLabel($input: CreateBarcodeLabelInput!) { createBarcodeLabel(input: $input) { barcodeLabel { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } } ``` ```json Variables { "input": { "entityId": "id", "templateId": "id" } } ``` ```json Response { "data": { "createBarcodeLabel": { "barcodeLabel": { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } } } } ``` # createBarcodePattern Source: https://docs.firstresonance.io/api-reference/mutations/createBarcodePattern **mutation** `createBarcodePattern(input: CreateBarcodePatternInput!): CreateBarcodePattern` ## Arguments **`input`**: `CreateBarcodePatternInput!` (required) ## Returns `CreateBarcodePattern` **`barcodePattern`**: `BarcodePattern` ## Examples ```graphql Mutation mutation CreateBarcodePattern($input: CreateBarcodePatternInput!) { createBarcodePattern(input: $input) { barcodePattern { LastSessionId _created _etag _updated barcodePatternJson createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "entityType": "LOCATIONS" } } ``` ```json Response { "data": { "createBarcodePattern": { "barcodePattern": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodePatternJson": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createBarcodePrintRequest Source: https://docs.firstresonance.io/api-reference/mutations/createBarcodePrintRequest **mutation** `createBarcodePrintRequest(input: CreateBarcodePrintRequestInput!): CreateBarcodePrintRequest` ## Arguments **`input`**: `CreateBarcodePrintRequestInput!` (required) ## Returns `CreateBarcodePrintRequest` **`barcodePrintRequest`**: `BarcodePrintRequest` ## Examples ```graphql Mutation mutation CreateBarcodePrintRequest($input: CreateBarcodePrintRequestInput!) { createBarcodePrintRequest(input: $input) { barcodePrintRequest { LastSessionId _created _etag _updated barcodeLabel { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } barcodeLabelId } } } ``` ```json Variables { "input": { "barcodeLabelId": 1 } } ``` ```json Response { "data": { "createBarcodePrintRequest": { "barcodePrintRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabel": { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 }, "barcodeLabelId": 1 } } } } ``` # createBarcodeTemplate Source: https://docs.firstresonance.io/api-reference/mutations/createBarcodeTemplate **mutation** `createBarcodeTemplate(input: CreateBarcodeTemplateInput!): CreateBarcodeTemplate` ## Arguments **`input`**: `CreateBarcodeTemplateInput!` (required) ## Returns `CreateBarcodeTemplate` **`barcodeTemplate`**: `BarcodeTemplate` ## Examples ```graphql Mutation mutation CreateBarcodeTemplate($input: CreateBarcodeTemplateInput!) { createBarcodeTemplate(input: $input) { barcodeTemplate { LastSessionId _BarcodeLabelsCount _created _etag _updated barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } } } ``` ```json Variables { "input": { "entityType": "LOCATIONS", "name": "string" } } ``` ```json Response { "data": { "createBarcodeTemplate": { "barcodeTemplate": { "LastSessionId": "string", "_BarcodeLabelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ] } } } } ``` # createBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/createBuildRequirement **mutation** `createBuildRequirement(input: CreateBuildRequirementInput!): CreateBuildRequirement` ## Arguments **`input`**: `CreateBuildRequirementInput!` (required) ## Returns `CreateBuildRequirement` **`buildRequirement`**: `BuildRequirement` ## Examples ```graphql Mutation mutation CreateBuildRequirement($input: CreateBuildRequirementInput!) { createBuildRequirement(input: $input) { buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } } } ``` ```json Variables { "input": { "partId": 1, "partInventoryId": 1, "quantityPerParentPartInventory": 1.5 } } ``` ```json Response { "data": { "createBuildRequirement": { "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 } } } } ``` # createBuildRequirementForBatch Source: https://docs.firstresonance.io/api-reference/mutations/createBuildRequirementForBatch Adds a new build requirement to every unit in a run step's batch in one atomic request, instead of creating it per unit. The whole batch rolls back if any unit fails validation. **mutation** `createBuildRequirementForBatch(input: CreateBuildRequirementForBatchInput!): CreateBuildRequirementForBatch` ## Arguments **`input`**: `CreateBuildRequirementForBatchInput!` (required) ## Returns `CreateBuildRequirementForBatch` **`buildRequirements`**: `[BuildRequirement]` --- **`createdCount`**: `Int` --- **`skippedAlreadyPresentCount`**: `Int` ## Examples ```graphql Mutation mutation CreateBuildRequirementForBatch($input: CreateBuildRequirementForBatchInput!) { createBuildRequirementForBatch(input: $input) { buildRequirements { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } createdCount skippedAlreadyPresentCount } } ``` ```json Variables { "input": { "partId": 1, "quantityPerParentPartInventory": 1.5, "runStepId": 1 } } ``` ```json Response { "data": { "createBuildRequirementForBatch": { "buildRequirements": [ { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 } ], "createdCount": 1, "skippedAlreadyPresentCount": 1 } } } ``` # createBuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/mutations/createBuildRequirementReferenceDesignator **mutation** `createBuildRequirementReferenceDesignator(input: CreateBuildRequirementReferenceDesignatorInput!): CreateBuildRequirementReferenceDesignator` ## Arguments **`input`**: `CreateBuildRequirementReferenceDesignatorInput!` (required) ## Returns `CreateBuildRequirementReferenceDesignator` **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignator` ## Examples ```graphql Mutation mutation CreateBuildRequirementReferenceDesignator($input: CreateBuildRequirementReferenceDesignatorInput!) { createBuildRequirementReferenceDesignator(input: $input) { buildRequirementReferenceDesignator { LastSessionId _AbomInstallationsCount _InstalledPartInventoriesCount _created _etag _updated } } } ``` ```json Variables { "input": { "buildRequirementId": 1, "value": "string" } } ``` ```json Response { "data": { "createBuildRequirementReferenceDesignator": { "buildRequirementReferenceDesignator": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_InstalledPartInventoriesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/createBuildRequirementSubstitute **mutation** `createBuildRequirementSubstitute(input: CreateBuildRequirementSubstituteInput!): CreateBuildRequirementSubstitute` ## Arguments **`input`**: `CreateBuildRequirementSubstituteInput!` (required) ## Returns `CreateBuildRequirementSubstitute` **`buildRequirementSubstitute`**: `BuildRequirementSubstitute` ## Examples ```graphql Mutation mutation CreateBuildRequirementSubstitute($input: CreateBuildRequirementSubstituteInput!) { createBuildRequirementSubstitute(input: $input) { buildRequirementSubstitute { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "buildRequirementId": 1, "partId": 1 } } ``` ```json Response { "data": { "createBuildRequirementSubstitute": { "buildRequirementSubstitute": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } } ``` # createChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/createChangeOrder **mutation** `createChangeOrder(input: CreateChangeOrderInput!): CreateChangeOrder` ## Arguments **`input`**: `CreateChangeOrderInput!` (required) ## Returns `CreateChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation CreateChangeOrder($input: CreateChangeOrderInput!) { createChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "changeOrderType": "MBOM_CHANGE", "targetEntityId": 1, "title": "string" } } ``` ```json Response { "data": { "createChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # createChangeOrderApproval Source: https://docs.firstresonance.io/api-reference/mutations/createChangeOrderApproval **mutation** `createChangeOrderApproval(input: CreateChangeOrderApprovalInput!): CreateChangeOrderApproval` ## Arguments **`input`**: `CreateChangeOrderApprovalInput!` (required) ## Returns `CreateChangeOrderApproval` **`approval`**: `ChangeOrderApproval` ## Examples ```graphql Mutation mutation CreateChangeOrderApproval($input: CreateChangeOrderApprovalInput!) { createChangeOrderApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } } ``` ```json Variables { "input": { "changeOrderId": "id", "gateType": "APPROVED" } } ``` ```json Response { "data": { "createChangeOrderApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } } ``` # createChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createChangeOrderApprovalRequest **mutation** `createChangeOrderApprovalRequest(input: CreateChangeOrderApprovalRequestInput!): CreateChangeOrderApprovalRequest` ## Arguments **`input`**: `CreateChangeOrderApprovalRequestInput!` (required) ## Returns `CreateChangeOrderApprovalRequest` **`approvalRequest`**: `ChangeOrderApprovalRequest` ## Examples ```graphql Mutation mutation CreateChangeOrderApprovalRequest($input: CreateChangeOrderApprovalRequestInput!) { createChangeOrderApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "changeOrderId": "id", "gateType": "APPROVED", "roleId": "id" } } ``` ```json Response { "data": { "createChangeOrderApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/createChangeOrderApprovalRole **mutation** `createChangeOrderApprovalRole(input: CreateChangeOrderApprovalRoleInput!): CreateChangeOrderApprovalRole` ## Arguments **`input`**: `CreateChangeOrderApprovalRoleInput!` (required) ## Returns `CreateChangeOrderApprovalRole` **`approvalRole`**: `ChangeOrderApprovalRole` ## Examples ```graphql Mutation mutation CreateChangeOrderApprovalRole($input: CreateChangeOrderApprovalRoleInput!) { createChangeOrderApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "count": 1, "gateType": "APPROVED", "roleId": "id" } } ``` ```json Response { "data": { "createChangeOrderApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createChargeAccount Source: https://docs.firstresonance.io/api-reference/mutations/createChargeAccount **mutation** `createChargeAccount(input: CreateChargeAccountInput!): CreateChargeAccount` ## Arguments **`input`**: `CreateChargeAccountInput!` (required) ## Returns `CreateChargeAccount` **`chargeAccount`**: `ChargeAccount` ## Examples ```graphql Mutation mutation CreateChargeAccount($input: CreateChargeAccountInput!) { createChargeAccount(input: $input) { chargeAccount { LastSessionId _created _etag _updated archived code } } } ``` ```json Variables { "input": { "code": "string", "title": "string" } } ``` ```json Response { "data": { "createChargeAccount": { "chargeAccount": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } } } ``` # createComment Source: https://docs.firstresonance.io/api-reference/mutations/createComment **mutation** `createComment(input: CreateCommentInput!): CreateComment` ## Arguments **`input`**: `CreateCommentInput!` (required) ## Returns `CreateComment` **`comment`**: `Comment` ## Examples ```graphql Mutation mutation CreateComment($input: CreateCommentInput!) { createComment(input: $input) { comment { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createComment": { "comment": { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } } } } ``` # createContact Source: https://docs.firstresonance.io/api-reference/mutations/createContact **mutation** `createContact(input: CreateContactInput!): CreateContact` ## Arguments **`input`**: `CreateContactInput!` (required) ## Returns `CreateContact` **`contact`**: `Contact` ## Examples ```graphql Mutation mutation CreateContact($input: CreateContactInput!) { createContact(input: $input) { contact { LastSessionId _LocationsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createContact": { "contact": { "LastSessionId": "string", "_LocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createCurrency Source: https://docs.firstresonance.io/api-reference/mutations/createCurrency **mutation** `createCurrency(input: CreateCurrencyInput!): CreateCurrency` ## Arguments **`input`**: `CreateCurrencyInput!` (required) ## Returns `CreateCurrency` **`currency`**: `Currency` ## Examples ```graphql Mutation mutation CreateCurrency($input: CreateCurrencyInput!) { createCurrency(input: $input) { currency { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "type": "string" } } ``` ```json Response { "data": { "createCurrency": { "currency": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createDatagridColumn Source: https://docs.firstresonance.io/api-reference/mutations/createDatagridColumn **mutation** `createDatagridColumn(input: CreateDatagridColumnInput!): CreateDatagridColumn` ## Arguments **`input`**: `CreateDatagridColumnInput!` (required) ## Returns `CreateDatagridColumn` **`datagridColumn`**: `DatagridColumn` ## Examples ```graphql Mutation mutation CreateDatagridColumn($input: CreateDatagridColumnInput!) { createDatagridColumn(input: $input) { datagridColumn { LastSessionId Settable _ValuesCount _created _etag _updated } } } ``` ```json Variables { "input": { "type": "BOOLEAN" } } ``` ```json Response { "data": { "createDatagridColumn": { "datagridColumn": { "LastSessionId": "string", "Settable": true, "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createDatagridRow Source: https://docs.firstresonance.io/api-reference/mutations/createDatagridRow **mutation** `createDatagridRow(input: CreateDatagridRowInput!): CreateDatagridRow` ## Arguments **`input`**: `CreateDatagridRowInput!` (required) ## Returns `CreateDatagridRow` **`datagridRow`**: `DatagridRow` ## Examples ```graphql Mutation mutation CreateDatagridRow($input: CreateDatagridRowInput!) { createDatagridRow(input: $input) { datagridRow { LastSessionId _ValuesCount _created _etag _updated allBatchedSiblings { __typename } } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createDatagridRow": { "datagridRow": { "LastSessionId": "string", "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "DatagridRow" } ] } } } } ``` # createFileAttachment Source: https://docs.firstresonance.io/api-reference/mutations/createFileAttachment Attaches a file to an object in ION, such as a run, step, or part. **mutation** `createFileAttachment(input: CreateFileAttachmentInput!): CreateFileAttachment` ## Arguments **`input`**: `CreateFileAttachmentInput!` (required) ## Returns `CreateFileAttachment` **`fileAttachment`**: `FileAttachment` --- **`uploadUrl`**: `String` ## Examples ```graphql Mutation mutation CreateFileAttachment($input: CreateFileAttachmentInput!) { createFileAttachment(input: $input) { fileAttachment { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } uploadUrl } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createFileAttachment": { "fileAttachment": { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" }, "uploadUrl": "string" } } } ``` # createFurtherAction Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherAction **mutation** `createFurtherAction(input: CreateFurtherActionInput!): CreateFurtherAction` ## Arguments **`input`**: `CreateFurtherActionInput!` (required) ## Returns `CreateFurtherAction` **`furtherAction`**: `FurtherAction` ## Examples ```graphql Mutation mutation CreateFurtherAction($input: CreateFurtherActionInput!) { createFurtherAction(input: $input) { furtherAction { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } } ``` ```json Variables { "input": { "title": "string" } } ``` ```json Response { "data": { "createFurtherAction": { "furtherAction": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } } } ``` # createFurtherActionApproval Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherActionApproval **mutation** `createFurtherActionApproval(input: CreateFurtherActionApprovalInput!): CreateFurtherActionApproval` ## Arguments **`input`**: `CreateFurtherActionApprovalInput!` (required) ## Returns `CreateFurtherActionApproval` **`approval`**: `FurtherActionApproval` ## Examples ```graphql Mutation mutation CreateFurtherActionApproval($input: CreateFurtherActionApprovalInput!) { createFurtherActionApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "furtherActionId": "id", "gateType": "RESOLVED" } } ``` ```json Response { "data": { "createFurtherActionApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createFurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherActionApprovalRequest **mutation** `createFurtherActionApprovalRequest(input: CreateFurtherActionApprovalRequestInput!): CreateFurtherActionApprovalRequest` ## Arguments **`input`**: `CreateFurtherActionApprovalRequestInput!` (required) ## Returns `CreateFurtherActionApprovalRequest` **`approvalRequest`**: `FurtherActionApprovalRequest` ## Examples ```graphql Mutation mutation CreateFurtherActionApprovalRequest($input: CreateFurtherActionApprovalRequestInput!) { createFurtherActionApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "furtherActionId": "id", "gateType": "RESOLVED", "roleId": "id" } } ``` ```json Response { "data": { "createFurtherActionApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createFurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherActionApprovalRole **mutation** `createFurtherActionApprovalRole(input: CreateFurtherActionApprovalRoleInput!): CreateFurtherActionApprovalRole` ## Arguments **`input`**: `CreateFurtherActionApprovalRoleInput!` (required) ## Returns `CreateFurtherActionApprovalRole` **`approvalRole`**: `FurtherActionApprovalRole` ## Examples ```graphql Mutation mutation CreateFurtherActionApprovalRole($input: CreateFurtherActionApprovalRoleInput!) { createFurtherActionApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "count": 1, "gateType": "RESOLVED", "roleId": "id" } } ``` ```json Response { "data": { "createFurtherActionApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createFurtherActionIssue Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherActionIssue **mutation** `createFurtherActionIssue(input: CreateFurtherActionIssueInput!): CreateFurtherActionIssue` ## Arguments **`input`**: `CreateFurtherActionIssueInput!` (required) ## Returns `CreateFurtherActionIssue` **`furtherActionIssue`**: `FurtherActionIssue` ## Examples ```graphql Mutation mutation CreateFurtherActionIssue($input: CreateFurtherActionIssueInput!) { createFurtherActionIssue(input: $input) { furtherActionIssue { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "furtherActionId": 1, "issueId": 1 } } ``` ```json Response { "data": { "createFurtherActionIssue": { "furtherActionIssue": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # createFurtherActionPart Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherActionPart **mutation** `createFurtherActionPart(input: CreateFurtherActionPartInput!): CreateFurtherActionPart` ## Arguments **`input`**: `CreateFurtherActionPartInput!` (required) ## Returns `CreateFurtherActionPart` **`furtherActionPart`**: `FurtherActionPart` ## Examples ```graphql Mutation mutation CreateFurtherActionPart($input: CreateFurtherActionPartInput!) { createFurtherActionPart(input: $input) { furtherActionPart { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "furtherActionId": 1, "partId": 1 } } ``` ```json Response { "data": { "createFurtherActionPart": { "furtherActionPart": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # createFurtherActionRun Source: https://docs.firstresonance.io/api-reference/mutations/createFurtherActionRun **mutation** `createFurtherActionRun(input: CreateFurtherActionRunInput!): CreateFurtherActionRun` ## Arguments **`input`**: `CreateFurtherActionRunInput!` (required) ## Returns `CreateFurtherActionRun` **`furtherActionRun`**: `FurtherActionRun` ## Examples ```graphql Mutation mutation CreateFurtherActionRun($input: CreateFurtherActionRunInput!) { createFurtherActionRun(input: $input) { furtherActionRun { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "furtherActionId": 1, "runId": 1 } } ``` ```json Response { "data": { "createFurtherActionRun": { "furtherActionRun": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # createImportJob Source: https://docs.firstresonance.io/api-reference/mutations/createImportJob **mutation** `createImportJob(input: CreateImportJobInput!): CreateImportJob` ## Arguments **`input`**: `CreateImportJobInput!` (required) ## Returns `CreateImportJob` **`importJob`**: `ImportJob` ## Examples ```graphql Mutation mutation CreateImportJob($input: CreateImportJobInput!) { createImportJob(input: $input) { importJob { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "type": "ABOM_INSTALLATIONS" } } ``` ```json Response { "data": { "createImportJob": { "importJob": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createIntentOption Source: https://docs.firstresonance.io/api-reference/mutations/createIntentOption **mutation** `createIntentOption(input: CreateIntentOptionInput!): CreateIntentOption` ## Arguments **`input`**: `CreateIntentOptionInput!` (required) ## Returns `CreateIntentOption` **`intentOption`**: `IntentOption` ## Examples ```graphql Mutation mutation CreateIntentOption($input: CreateIntentOptionInput!) { createIntentOption(input: $input) { intentOption { LastSessionId _IssueDispositionTypesCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "rank": 1, "value": "string" } } ``` ```json Response { "data": { "createIntentOption": { "intentOption": { "LastSessionId": "string", "_IssueDispositionTypesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createInvite Source: https://docs.firstresonance.io/api-reference/mutations/createInvite **mutation** `createInvite(input: CreateInviteInput!): CreateInvite` ## Arguments **`input`**: `CreateInviteInput!` (required) ## Returns `CreateInvite` **`invite`**: `Invite` ## Examples ```graphql Mutation mutation CreateInvite($input: CreateInviteInput!) { createInvite(input: $input) { invite { LastSessionId _created _etag _updated auth0InvitationId auth0OrgId } } } ``` ```json Variables { "input": { "email": "string" } } ``` ```json Response { "data": { "createInvite": { "invite": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0InvitationId": "string", "auth0OrgId": "string" } } } } ``` # createIssue Source: https://docs.firstresonance.io/api-reference/mutations/createIssue **mutation** `createIssue(input: CreateIssueInput!): CreateIssue` ## Arguments **`input`**: `CreateIssueInput!` (required) ## Returns `CreateIssue` **`issue`**: `Issue` ## Examples ```graphql Mutation mutation CreateIssue($input: CreateIssueInput!) { createIssue(input: $input) { issue { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createIssue": { "issue": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } } } ``` # createIssueApproval Source: https://docs.firstresonance.io/api-reference/mutations/createIssueApproval **mutation** `createIssueApproval(input: CreateIssueApprovalInput!): CreateIssueApproval` ## Arguments **`input`**: `CreateIssueApprovalInput!` (required) ## Returns `CreateIssueApproval` **`approval`**: `IssueApproval` ## Examples ```graphql Mutation mutation CreateIssueApproval($input: CreateIssueApprovalInput!) { createIssueApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "issueApprovalGateType": "IN_PROGRESS", "issueId": "id" } } ``` ```json Response { "data": { "createIssueApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createIssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createIssueApprovalRequest **mutation** `createIssueApprovalRequest(input: CreateIssueApprovalRequestInput!): CreateIssueApprovalRequest` ## Arguments **`input`**: `CreateIssueApprovalRequestInput!` (required) ## Returns `CreateIssueApprovalRequest` **`approvalRequest`**: `IssueApprovalRequest` ## Examples ```graphql Mutation mutation CreateIssueApprovalRequest($input: CreateIssueApprovalRequestInput!) { createIssueApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "issueApprovalGateType": "IN_PROGRESS", "issueId": "id", "roleId": "id" } } ``` ```json Response { "data": { "createIssueApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createIssueDispositionType Source: https://docs.firstresonance.io/api-reference/mutations/createIssueDispositionType **mutation** `createIssueDispositionType(input: CreateIssueDispositionTypeInput!): CreateIssueDispositionType` ## Arguments **`input`**: `CreateIssueDispositionTypeInput!` (required) ## Returns `CreateIssueDispositionType` **`issueDispositionType`**: `IssueDispositionType` ## Examples ```graphql Mutation mutation CreateIssueDispositionType($input: CreateIssueDispositionTypeInput!) { createIssueDispositionType(input: $input) { issueDispositionType { LastSessionId _IssueDispositionTypeRolesCount _IssuesCount _RolesCount _created _etag } } } ``` ```json Variables { "input": { "active": true, "title": "string" } } ``` ```json Response { "data": { "createIssueDispositionType": { "issueDispositionType": { "LastSessionId": "string", "_IssueDispositionTypeRolesCount": 1, "_IssuesCount": 1, "_RolesCount": 1, "_created": "value", "_etag": "string" } } } } ``` # createIssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/mutations/createIssueDispositionTypeRole **mutation** `createIssueDispositionTypeRole(input: CreateIssueDispositionTypeRoleInput!): CreateIssueDispositionTypeRole` ## Arguments **`input`**: `CreateIssueDispositionTypeRoleInput!` (required) ## Returns `CreateIssueDispositionTypeRole` **`issueDispositionTypeRole`**: `IssueDispositionTypeRole` ## Examples ```graphql Mutation mutation CreateIssueDispositionTypeRole($input: CreateIssueDispositionTypeRoleInput!) { createIssueDispositionTypeRole(input: $input) { issueDispositionTypeRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "issueApprovalGateType": "IN_PROGRESS", "issueDispositionTypeId": 1, "roleId": 1 } } ``` ```json Response { "data": { "createIssueDispositionTypeRole": { "issueDispositionTypeRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createIssuePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/createIssuePartInventory **mutation** `createIssuePartInventory(input: CreateIssuePartInventoryInput!): CreateIssuePartInventory` ## Arguments **`input`**: `CreateIssuePartInventoryInput!` (required) ## Returns `CreateIssuePartInventory` **`issuePartInventory`**: `IssuePartInventory` ## Examples ```graphql Mutation mutation CreateIssuePartInventory($input: CreateIssuePartInventoryInput!) { createIssuePartInventory(input: $input) { issuePartInventory { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "issueId": 1, "partInventoryId": 1 } } ``` ```json Response { "data": { "createIssuePartInventory": { "issuePartInventory": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # createIssueRelation Source: https://docs.firstresonance.io/api-reference/mutations/createIssueRelation **mutation** `createIssueRelation(input: CreateIssueRelationInput!): CreateIssueRelation` ## Arguments **`input`**: `CreateIssueRelationInput!` (required) ## Returns `CreateIssueRelation` **`issueRelation`**: `IssueRelation` ## Examples ```graphql Mutation mutation CreateIssueRelation($input: CreateIssueRelationInput!) { createIssueRelation(input: $input) { issueRelation { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "originIssueId": "id", "relatedIssueId": "id" } } ``` ```json Response { "data": { "createIssueRelation": { "issueRelation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # createIssues Source: https://docs.firstresonance.io/api-reference/mutations/createIssues Creates one or more issues. Issues are used to track non-conformances and other quality events. **mutation** `createIssues(input: [CreateIssueInput]): CreateIssues` ## Arguments **`input`**: `[CreateIssueInput]` ## Returns `CreateIssues` **`issues`**: `[Issue]` ## Examples ```graphql Mutation mutation CreateIssues { createIssues { issues { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } } ``` ```json Response { "data": { "createIssues": { "issues": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } ] } } } ``` # createKitForRun Source: https://docs.firstresonance.io/api-reference/mutations/createKitForRun Creates a kit of parts required for a specific run. **mutation** `createKitForRun(input: CreateKitForRunInput!): CreateKitForRun` ## Arguments **`input`**: `CreateKitForRunInput!` (required) ## Returns `CreateKitForRun` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation CreateKitForRun($input: CreateKitForRunInput!) { createKitForRun(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": { "runId": "id" } } ``` ```json Response { "data": { "createKitForRun": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # createLabel Source: https://docs.firstresonance.io/api-reference/mutations/createLabel **mutation** `createLabel(input: CreateLabelInput!): CreateLabel` ## Arguments **`input`**: `CreateLabelInput!` (required) ## Returns `CreateLabel` **`label`**: `Label` ## Examples ```graphql Mutation mutation CreateLabel($input: CreateLabelInput!) { createLabel(input: $input) { label { LastSessionId _EntitiesCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "value": "string" } } ``` ```json Response { "data": { "createLabel": { "label": { "LastSessionId": "string", "_EntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createLocation Source: https://docs.firstresonance.io/api-reference/mutations/createLocation **mutation** `createLocation(input: CreateLocationInput!): CreateLocation` ## Arguments **`input`**: `CreateLocationInput!` (required) ## Returns `CreateLocation` **`location`**: `Location` ## Examples ```graphql Mutation mutation CreateLocation($input: CreateLocationInput!) { createLocation(input: $input) { location { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AllChildrenCount _AllParentsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createLocation": { "location": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createLocationSubtype Source: https://docs.firstresonance.io/api-reference/mutations/createLocationSubtype **mutation** `createLocationSubtype(input: CreateLocationSubtypeInput!): CreateLocationSubtype` ## Arguments **`input`**: `CreateLocationSubtypeInput!` (required) ## Returns `CreateLocationSubtype` **`locationSubtype`**: `LocationSubtype` ## Examples ```graphql Mutation mutation CreateLocationSubtype($input: CreateLocationSubtypeInput!) { createLocationSubtype(input: $input) { locationSubtype { LastSessionId _LocationsCount _StepsCount _created _etag _updated } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createLocationSubtype": { "locationSubtype": { "LastSessionId": "string", "_LocationsCount": 1, "_StepsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createManyAbomInstallations Source: https://docs.firstresonance.io/api-reference/mutations/createManyAbomInstallations Atomically records many component installations onto as-built bills of materials (aBOMs) in one request. The whole batch rolls back if any row fails validation. **mutation** `createManyAbomInstallations(input: [CreateABomInstallationInput]!): CreateManyABomInstallations` ## Arguments **`input`**: `[CreateABomInstallationInput]!` (required) ## Returns `CreateManyABomInstallations` **`abomInstallations`**: `[ABomInstallation]` ## Examples ```graphql Mutation mutation CreateManyAbomInstallations($input: [CreateABomInstallationInput]!) { createManyAbomInstallations(input: $input) { abomInstallations { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": [ { "buildRequirementId": 1, "partInventoryId": 1, "quantity": 1.5 } ] } ``` ```json Response { "data": { "createManyAbomInstallations": { "abomInstallations": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } ] } } } ``` # createMbom Source: https://docs.firstresonance.io/api-reference/mutations/createMbom **mutation** `createMbom(input: CreateMBomInput!): CreateMBom` ## Arguments **`input`**: `CreateMBomInput!` (required) ## Returns `CreateMBom` **`mbom`**: `MBom` ## Examples ```graphql Mutation mutation CreateMbom($input: CreateMBomInput!) { createMbom(input: $input) { mbom { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "partId": "id" } } ``` ```json Response { "data": { "createMbom": { "mbom": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createMbomApproval Source: https://docs.firstresonance.io/api-reference/mutations/createMbomApproval **mutation** `createMbomApproval(input: CreateMBomApprovalInput!): CreateMBomApproval` ## Arguments **`input`**: `CreateMBomApprovalInput!` (required) ## Returns `CreateMBomApproval` **`approval`**: `MBomApproval` ## Examples ```graphql Mutation mutation CreateMbomApproval($input: CreateMBomApprovalInput!) { createMbomApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "gateType": "RELEASED", "mbomId": "id" } } ``` ```json Response { "data": { "createMbomApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createMbomApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createMbomApprovalRequest **mutation** `createMbomApprovalRequest(input: CreateMBomApprovalRequestInput!): CreateMBomApprovalRequest` ## Arguments **`input`**: `CreateMBomApprovalRequestInput!` (required) ## Returns `CreateMBomApprovalRequest` **`approvalRequest`**: `MBomApprovalRequest` ## Examples ```graphql Mutation mutation CreateMbomApprovalRequest($input: CreateMBomApprovalRequestInput!) { createMbomApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "gateType": "RELEASED", "mbomId": "id", "roleId": "id" } } ``` ```json Response { "data": { "createMbomApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createMbomApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/createMbomApprovalRole **mutation** `createMbomApprovalRole(input: CreateMBomApprovalRoleInput!): CreateMBomApprovalRole` ## Arguments **`input`**: `CreateMBomApprovalRoleInput!` (required) ## Returns `CreateMBomApprovalRole` **`approvalRole`**: `MBomApprovalRole` ## Examples ```graphql Mutation mutation CreateMbomApprovalRole($input: CreateMBomApprovalRoleInput!) { createMbomApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "count": 1, "gateType": "RELEASED", "roleId": "id" } } ``` ```json Response { "data": { "createMbomApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createMbomChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/createMbomChangeOrder Creates an mBOM change order and a line per inventory, in one transaction. **mutation** `createMbomChangeOrder(input: CreateMbomChangeOrderInput!): CreateMbomChangeOrder` ## Arguments **`input`**: `CreateMbomChangeOrderInput!` (required) ## Returns `CreateMbomChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation CreateMbomChangeOrder($input: CreateMbomChangeOrderInput!) { createMbomChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "targetMbomId": 1, "title": "string" } } ``` ```json Response { "data": { "createMbomChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # createMbomChangeOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/createMbomChangeOrderLine **mutation** `createMbomChangeOrderLine(input: CreateMbomChangeOrderLineInput!): CreateMbomChangeOrderLine` ## Arguments **`input`**: `CreateMbomChangeOrderLineInput!` (required) ## Returns `CreateMbomChangeOrderLine` **`mbomChangeOrderLine`**: `MbomChangeOrderLine` ## Examples ```graphql Mutation mutation CreateMbomChangeOrderLine($input: CreateMbomChangeOrderLineInput!) { createMbomChangeOrderLine(input: $input) { mbomChangeOrderLine { LastSessionId _created _etag _updated appliedAt appliedBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "changeOrderId": 1, "partInventoryId": 1 } } ``` ```json Response { "data": { "createMbomChangeOrderLine": { "mbomChangeOrderLine": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "appliedAt": "value", "appliedBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createMbomChangeOrderLines Source: https://docs.firstresonance.io/api-reference/mutations/createMbomChangeOrderLines Starts one line per inventory under one change order; the target side loads once for the whole batch. **mutation** `createMbomChangeOrderLines(input: CreateMbomChangeOrderLinesInput!): CreateMbomChangeOrderLines` ## Arguments **`input`**: `CreateMbomChangeOrderLinesInput!` (required) ## Returns `CreateMbomChangeOrderLines` **`mbomChanges`**: `[MbomChangeOrderLine]` ## Examples ```graphql Mutation mutation CreateMbomChangeOrderLines($input: CreateMbomChangeOrderLinesInput!) { createMbomChangeOrderLines(input: $input) { mbomChanges { LastSessionId _created _etag _updated appliedAt appliedBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "changeOrderId": 1, "partInventoryIds": [ 1 ] } } ``` ```json Response { "data": { "createMbomChangeOrderLines": { "mbomChanges": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "appliedAt": "value", "appliedBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } ] } } } ``` # createMbomItem Source: https://docs.firstresonance.io/api-reference/mutations/createMbomItem **mutation** `createMbomItem(input: CreateMBomItemInput!): CreateMBomItem` ## Arguments **`input`**: `CreateMBomItemInput!` (required) ## Returns `CreateMBomItem` **`mbomItem`**: `MBomItem` ## Examples ```graphql Mutation mutation CreateMbomItem($input: CreateMBomItemInput!) { createMbomItem(input: $input) { mbomItem { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } } } ``` ```json Variables { "input": { "partId": "id", "quantity": 1.5 } } ``` ```json Response { "data": { "createMbomItem": { "mbomItem": { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } } } } ``` # createMbomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/mutations/createMbomItemReferenceDesignator **mutation** `createMbomItemReferenceDesignator(input: CreateMBomItemReferenceDesignatorInput!): CreateMBomItemReferenceDesignator` ## Arguments **`input`**: `CreateMBomItemReferenceDesignatorInput!` (required) ## Returns `CreateMBomItemReferenceDesignator` **`mbomItemReferenceDesignator`**: `MBomItemReferenceDesignator` ## Examples ```graphql Mutation mutation CreateMbomItemReferenceDesignator($input: CreateMBomItemReferenceDesignatorInput!) { createMbomItemReferenceDesignator(input: $input) { mbomItemReferenceDesignator { LastSessionId _BuildRequirementReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _created _etag } } } ``` ```json Variables { "input": { "mbomItemId": "id", "value": "string" } } ``` ```json Response { "data": { "createMbomItemReferenceDesignator": { "mbomItemReferenceDesignator": { "LastSessionId": "string", "_BuildRequirementReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_created": "value", "_etag": "string" } } } } ``` # createMbomSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/createMbomSubstitute **mutation** `createMbomSubstitute(input: CreateMBomSubstituteInput!): CreateMBomSubstitute` ## Arguments **`input`**: `CreateMBomSubstituteInput!` (required) ## Returns `CreateMBomSubstitute` **`mbomSubstitute`**: `MBomSubstitute` ## Examples ```graphql Mutation mutation CreateMbomSubstitute($input: CreateMBomSubstituteInput!) { createMbomSubstitute(input: $input) { mbomSubstitute { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } } } ``` ```json Variables { "input": { "mbomItemId": "id", "partId": "id" } } ``` ```json Response { "data": { "createMbomSubstitute": { "mbomSubstitute": { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createMbomSubstitutes Source: https://docs.firstresonance.io/api-reference/mutations/createMbomSubstitutes Creates substitute parts for an item in a manufacturing bill of materials (mBOM). Substitutes can be used if the primary part is not available. **mutation** `createMbomSubstitutes(input: [CreateMBomSubstituteInput]): CreateMBomSubstitutes` ## Arguments **`input`**: `[CreateMBomSubstituteInput]` ## Returns `CreateMBomSubstitutes` **`mbomSubstitutes`**: `[MBomSubstitute]` ## Examples ```graphql Mutation mutation CreateMbomSubstitutes { createMbomSubstitutes { mbomSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } } } ``` ```json Response { "data": { "createMbomSubstitutes": { "mbomSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ] } } } ``` # createMrpJob Source: https://docs.firstresonance.io/api-reference/mutations/createMrpJob **mutation** `createMrpJob(input: CreateMRPJobInput!): CreateMRPJob` ## Arguments **`input`**: `CreateMRPJobInput!` (required) ## Returns `CreateMRPJob` **`mrpJob`**: `MRPJob` ## Examples ```graphql Mutation mutation CreateMrpJob($input: CreateMRPJobInput!) { createMrpJob(input: $input) { mrpJob { LastSessionId _CommentsCount _PlanItemsCount _created _etag _updated } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createMrpJob": { "mrpJob": { "LastSessionId": "string", "_CommentsCount": 1, "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createMultipleMbomItems Source: https://docs.firstresonance.io/api-reference/mutations/createMultipleMbomItems Adds multiple items to a manufacturing bill of materials (mBOM). **mutation** `createMultipleMbomItems(input: CreateMultipleMBomItemsInput!): CreateMultipleMBomItems` ## Arguments **`input`**: `CreateMultipleMBomItemsInput!` (required) ## Returns `CreateMultipleMBomItems` **`mbomItems`**: `[MBomItem]` ## Examples ```graphql Mutation mutation CreateMultipleMbomItems($input: CreateMultipleMBomItemsInput!) { createMultipleMbomItems(input: $input) { mbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createMultipleMbomItems": { "mbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ] } } } ``` # createOrUpdateMultipleMboms Source: https://docs.firstresonance.io/api-reference/mutations/createOrUpdateMultipleMboms Creates or updates multiple manufacturing bills of materials (mBOMs). **mutation** `createOrUpdateMultipleMboms(input: CreateOrUpdateMultipleMBomsNotationInput!): CreateOrUpdateMultipleMboms` ## Arguments **`input`**: `CreateOrUpdateMultipleMBomsNotationInput!` (required) ## Returns `CreateOrUpdateMultipleMboms` **`errorMessages`**: `[MultipleMbomCreationErrors]` --- **`newMbomRowIds`**: `[Int]` ## Examples ```graphql Mutation mutation CreateOrUpdateMultipleMboms($input: CreateOrUpdateMultipleMBomsNotationInput!) { createOrUpdateMultipleMboms(input: $input) { errorMessages { errorMsg rowId } newMbomRowIds } } ``` ```json Variables { "input": { "importerType": "DEPTH" } } ``` ```json Response { "data": { "createOrUpdateMultipleMboms": { "errorMessages": [ { "errorMsg": "string", "rowId": 1 } ], "newMbomRowIds": [ 1 ] } } } ``` # createOrUpdateMultipleMbomsCsv Source: https://docs.firstresonance.io/api-reference/mutations/createOrUpdateMultipleMbomsCsv Creates or updates multiple manufacturing bills of materials (mBOMs) from a CSV file. **mutation** `createOrUpdateMultipleMbomsCsv(input: CreateOrUpdateMultipleMBomsCsvInput!): CreateOrUpdateMultipleMBomsCsv` ## Arguments **`input`**: `CreateOrUpdateMultipleMBomsCsvInput!` (required) ## Returns `CreateOrUpdateMultipleMBomsCsv` **`errorMessages`**: `[MultipleMbomCreationErrors]` --- **`newMbomRowIds`**: `[Int]` ## Examples ```graphql Mutation mutation CreateOrUpdateMultipleMbomsCsv($input: CreateOrUpdateMultipleMBomsCsvInput!) { createOrUpdateMultipleMbomsCsv(input: $input) { errorMessages { errorMsg rowId } newMbomRowIds } } ``` ```json Variables { "input": { "importerType": "DEPTH", "s3Key": "string" } } ``` ```json Response { "data": { "createOrUpdateMultipleMbomsCsv": { "errorMessages": [ { "errorMsg": "string", "rowId": 1 } ], "newMbomRowIds": [ 1 ] } } } ``` # createOrUpdateMultipleParts Source: https://docs.firstresonance.io/api-reference/mutations/createOrUpdateMultipleParts Creates or updates multiple parts. **mutation** `createOrUpdateMultipleParts(input: CreateOrUpdateMultiplePartsInput!): CreateOrUpdateMultipleParts` ## Arguments **`input`**: `CreateOrUpdateMultiplePartsInput!` (required) ## Returns `CreateOrUpdateMultipleParts` **`parts`**: `[Part]` ## Examples ```graphql Mutation mutation CreateOrUpdateMultipleParts($input: CreateOrUpdateMultiplePartsInput!) { createOrUpdateMultipleParts(input: $input) { parts { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createOrUpdateMultipleParts": { "parts": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } ] } } } ``` # createOrganizationDomain Source: https://docs.firstresonance.io/api-reference/mutations/createOrganizationDomain **mutation** `createOrganizationDomain(input: CreateOrganizationDomainInput!): CreateOrganizationDomain` ## Arguments **`input`**: `CreateOrganizationDomainInput!` (required) ## Returns `CreateOrganizationDomain` **`organizationDomain`**: `OrganizationDomain` ## Examples ```graphql Mutation mutation CreateOrganizationDomain($input: CreateOrganizationDomainInput!) { createOrganizationDomain(input: $input) { organizationDomain { LastSessionId _created _etag _updated auth0DomainId createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "domain": "string" } } ``` ```json Response { "data": { "createOrganizationDomain": { "organizationDomain": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0DomainId": "string", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createOrganizationGlobalUniqueSerialNumberScheme Source: https://docs.firstresonance.io/api-reference/mutations/createOrganizationGlobalUniqueSerialNumberScheme Creates a global scheme for generating unique serial numbers. **mutation** `createOrganizationGlobalUniqueSerialNumberScheme(input: CreateGlobalUniqueSerialNumberSchemeSettingInput!): CreateOrganizationGlobalUniqueSerialNumberScheme` ## Arguments **`input`**: `CreateGlobalUniqueSerialNumberSchemeSettingInput!` (required) ## Returns `CreateOrganizationGlobalUniqueSerialNumberScheme` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation CreateOrganizationGlobalUniqueSerialNumberScheme($input: CreateGlobalUniqueSerialNumberSchemeSettingInput!) { createOrganizationGlobalUniqueSerialNumberScheme(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "name": "string", "serialScheme": "string" } } ``` ```json Response { "data": { "createOrganizationGlobalUniqueSerialNumberScheme": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # createOrganizationPartRevisionScheme Source: https://docs.firstresonance.io/api-reference/mutations/createOrganizationPartRevisionScheme Creates a part revision scheme for the organization. **mutation** `createOrganizationPartRevisionScheme(input: CreatePartRevisionSchemeSettingInput!): CreateOrganizationPartRevisionScheme` ## Arguments **`input`**: `CreatePartRevisionSchemeSettingInput!` (required) ## Returns `CreateOrganizationPartRevisionScheme` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation CreateOrganizationPartRevisionScheme($input: CreatePartRevisionSchemeSettingInput!) { createOrganizationPartRevisionScheme(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "format": [ "string" ], "id": "id", "name": "string" } } ``` ```json Response { "data": { "createOrganizationPartRevisionScheme": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # createPart Source: https://docs.firstresonance.io/api-reference/mutations/createPart Creates a new part in the Parts Library. **mutation** `createPart(input: CreatePartInput!): CreatePart` ## Arguments **`input`**: `CreatePartInput!` (required) ## Returns `CreatePart` **`part`**: `Part` ## Examples ```graphql Mutation mutation CreatePart($input: CreatePartInput!) { createPart(input: $input) { part { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } } ``` ```json Variables { "input": { "partNumber": "string" } } ``` ```json Response { "data": { "createPart": { "part": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } } } } ``` # createPartInventories Source: https://docs.firstresonance.io/api-reference/mutations/createPartInventories **mutation** `createPartInventories(input: [CreatePartInventoryInput]): CreatePartInventories` ## Arguments **`input`**: `[CreatePartInventoryInput]` ## Returns `CreatePartInventories` **`partInventories`**: `[PartInventory]` ## Examples ```graphql Mutation mutation CreatePartInventories { createPartInventories { partInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "createPartInventories": { "partInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # createPartInventory Source: https://docs.firstresonance.io/api-reference/mutations/createPartInventory **mutation** `createPartInventory(input: CreatePartInventoryInput!): CreatePartInventory` ## Arguments **`input`**: `CreatePartInventoryInput!` (required) ## Returns `CreatePartInventory` **`partInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation CreatePartInventory($input: CreatePartInventoryInput!) { createPartInventory(input: $input) { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "partId": "id" } } ``` ```json Response { "data": { "createPartInventory": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createPartKit Source: https://docs.firstresonance.io/api-reference/mutations/createPartKit **mutation** `createPartKit(input: CreatePartKitInput!): CreatePartKit` ## Arguments **`input`**: `CreatePartKitInput!` (required) ## Returns `CreatePartKit` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation CreatePartKit($input: CreatePartKitInput!) { createPartKit(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createPartKit": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # createPartKitItem Source: https://docs.firstresonance.io/api-reference/mutations/createPartKitItem **mutation** `createPartKitItem(input: CreatePartKitItemInput!): CreatePartKitItem` ## Arguments **`input`**: `CreatePartKitItemInput!` (required) ## Returns `CreatePartKitItem` **`partKitItem`**: `PartKitItem` ## Examples ```graphql Mutation mutation CreatePartKitItem($input: CreatePartKitItemInput!) { createPartKitItem(input: $input) { partKitItem { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createPartKitItem": { "partKitItem": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # createPartKitItems Source: https://docs.firstresonance.io/api-reference/mutations/createPartKitItems Create part kit items **mutation** `createPartKitItems(input: [CreatePartKitItemInput]): CreatePartKitItems` ## Arguments **`input`**: `[CreatePartKitItemInput]` ## Returns `CreatePartKitItems` **`partKitItems`**: `[PartKitItem]` ## Examples ```graphql Mutation mutation CreatePartKitItems { createPartKitItems { partKitItems { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "createPartKitItems": { "partKitItems": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } ] } } } ``` # createPartProcedure Source: https://docs.firstresonance.io/api-reference/mutations/createPartProcedure **mutation** `createPartProcedure(input: CreatePartProcedureInput!): CreatePartProcedure` ## Arguments **`input`**: `CreatePartProcedureInput!` (required) ## Returns `CreatePartProcedure` **`partProcedure`**: `PartProcedure` ## Examples ```graphql Mutation mutation CreatePartProcedure($input: CreatePartProcedureInput!) { createPartProcedure(input: $input) { partProcedure { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "partId": "id", "procedureId": "id" } } ``` ```json Response { "data": { "createPartProcedure": { "partProcedure": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # createPartRevision Source: https://docs.firstresonance.io/api-reference/mutations/createPartRevision Creates a new revision of a part. **mutation** `createPartRevision(input: CreatePartRevisionInput!): CreatePartRevision` ## Arguments **`input`**: `CreatePartRevisionInput!` (required) ## Returns `CreatePartRevision` **`part`**: `Part` ## Examples ```graphql Mutation mutation CreatePartRevision($input: CreatePartRevisionInput!) { createPartRevision(input: $input) { part { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "createPartRevision": { "part": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } } } } ``` # createPartSubtype Source: https://docs.firstresonance.io/api-reference/mutations/createPartSubtype **mutation** `createPartSubtype(input: CreatePartSubtypeInput!): CreatePartSubtype` ## Arguments **`input`**: `CreatePartSubtypeInput!` (required) ## Returns `CreatePartSubtype` **`partSubtype`**: `PartSubtype` ## Examples ```graphql Mutation mutation CreatePartSubtype($input: CreatePartSubtypeInput!) { createPartSubtype(input: $input) { partSubtype { LastSessionId _PartsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createPartSubtype": { "partSubtype": { "LastSessionId": "string", "_PartsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createPickOverrideEvent Source: https://docs.firstresonance.io/api-reference/mutations/createPickOverrideEvent **mutation** `createPickOverrideEvent(input: CreatePickOverrideEventInput!): CreatePickOverrideEvent` ## Arguments **`input`**: `CreatePickOverrideEventInput!` (required) ## Returns `CreatePickOverrideEvent` **`pickOverrideEvent`**: `PickOverrideEvent` ## Examples ```graphql Mutation mutation CreatePickOverrideEvent($input: CreatePickOverrideEventInput!) { createPickOverrideEvent(input: $input) { pickOverrideEvent { _created _updated chosenLocationId chosenPartId chosenPartInventoryId createdById } } } ``` ```json Variables { "input": { "chosenPartInventoryId": "id", "partId": "id", "partKitId": "id", "recommendedPartInventoryId": "id", "surface": "KITTING_BATCH" } } ``` ```json Response { "data": { "createPickOverrideEvent": { "pickOverrideEvent": { "_created": "value", "_updated": "value", "chosenLocationId": 1, "chosenPartId": 1, "chosenPartInventoryId": 1, "createdById": 1 } } } } ``` # createPickRun Source: https://docs.firstresonance.io/api-reference/mutations/createPickRun Plans a walk across a batch of kits, consolidating each bin into one stop. **mutation** `createPickRun(input: CreatePickRunInput!): CreatePickRun` ## Arguments **`input`**: `CreatePickRunInput!` (required) ## Returns `CreatePickRun` **`pickRun`**: `PickRun` ## Examples ```graphql Mutation mutation CreatePickRun($input: CreatePickRunInput!) { createPickRun(input: $input) { pickRun { Created Etag LastSessionId Updated _KitsCount _StopsCount } } } ``` ```json Variables { "input": { "partKitIds": [ "id" ] } } ``` ```json Response { "data": { "createPickRun": { "pickRun": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_KitsCount": 1, "_StopsCount": 1 } } } } ``` # createPlan Source: https://docs.firstresonance.io/api-reference/mutations/createPlan **mutation** `createPlan(input: CreatePlanInput!): CreatePlan` ## Arguments **`input`**: `CreatePlanInput!` (required) ## Returns `CreatePlan` **`plan`**: `Plan` ## Examples ```graphql Mutation mutation CreatePlan($input: CreatePlanInput!) { createPlan(input: $input) { plan { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createPlan": { "plan": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # createPlanConstraint Source: https://docs.firstresonance.io/api-reference/mutations/createPlanConstraint **mutation** `createPlanConstraint(input: CreatePlanConstraintInput!): CreatePlanConstraint` ## Arguments **`input`**: `CreatePlanConstraintInput!` (required) ## Returns `CreatePlanConstraint` **`planConstraint`**: `PlanConstraint` ## Examples ```graphql Mutation mutation CreatePlanConstraint($input: CreatePlanConstraintInput!) { createPlanConstraint(input: $input) { planConstraint { LastSessionId _PlanConstraintLocationsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "locationIds": [ 1 ], "operator": "IN", "planId": 1 } } ``` ```json Response { "data": { "createPlanConstraint": { "planConstraint": { "LastSessionId": "string", "_PlanConstraintLocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createPlanItem Source: https://docs.firstresonance.io/api-reference/mutations/createPlanItem **mutation** `createPlanItem(input: CreatePlanItemInput!): CreatePlanItem` ## Arguments **`input`**: `CreatePlanItemInput!` (required) ## Returns `CreatePlanItem` **`planItem`**: `PlanItem` ## Examples ```graphql Mutation mutation CreatePlanItem($input: CreatePlanItemInput!) { createPlanItem(input: $input) { planItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createPlanItem": { "planItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } } } ``` # createPlanItemAllocation Source: https://docs.firstresonance.io/api-reference/mutations/createPlanItemAllocation **mutation** `createPlanItemAllocation(input: CreatePlanItemAllocationInput!): CreatePlanItemAllocation` ## Arguments **`input`**: `CreatePlanItemAllocationInput!` (required) ## Returns `CreatePlanItemAllocation` **`planItemAllocation`**: `PlanItemAllocation` ## Examples ```graphql Mutation mutation CreatePlanItemAllocation($input: CreatePlanItemAllocationInput!) { createPlanItemAllocation(input: $input) { planItemAllocation { LastSessionId _created _etag _updated childPlanItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } childPlanItemId } } } ``` ```json Variables { "input": { "childPlanItemId": "id", "parentPlanItemId": "id", "quantity": 1.5 } } ``` ```json Response { "data": { "createPlanItemAllocation": { "planItemAllocation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "childPlanItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 }, "childPlanItemId": 1 } } } } ``` # createPlanReservation Source: https://docs.firstresonance.io/api-reference/mutations/createPlanReservation **mutation** `createPlanReservation(input: CreatePlanReservationInput!): CreatePlanReservation` ## Arguments **`input`**: `CreatePlanReservationInput!` (required) ## Returns `CreatePlanReservation` **`planReservation`**: `PlanReservation` ## Examples ```graphql Mutation mutation CreatePlanReservation($input: CreatePlanReservationInput!) { createPlanReservation(input: $input) { planReservation { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "quantity": 1.5 } } ``` ```json Response { "data": { "createPlanReservation": { "planReservation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createPrintJob Source: https://docs.firstresonance.io/api-reference/mutations/createPrintJob Creates a print job, for example to print barcode labels. **mutation** `createPrintJob(input: CreatePrintJobInput!): CreatePrintJob` ## Arguments **`input`**: `CreatePrintJobInput!` (required) ## Returns `CreatePrintJob` **`printJobId`**: `String!` ## Examples ```graphql Mutation mutation CreatePrintJob($input: CreatePrintJobInput!) { createPrintJob(input: $input) { printJobId } } ``` ```json Variables { "input": { "content": "string", "printerId": 1 } } ``` ```json Response { "data": { "createPrintJob": { "printJobId": "string" } } } ``` # createProcedure Source: https://docs.firstresonance.io/api-reference/mutations/createProcedure Creates a new procedure. Procedures are a set of instructions for building or testing a part. **mutation** `createProcedure(attributes: [ExtensibleAttributeInput], description: String, exportControlled: Boolean, input: CreateProcedureInput, intentOptionId: Int, title: String!, type: Proceduretypeenum): CreateProcedure` ## Arguments **`attributes`**: `[ExtensibleAttributeInput]` --- **`description`**: `String` --- **`exportControlled`**: `Boolean` --- **`input`**: `CreateProcedureInput` --- **`intentOptionId`**: `Int` --- **`title`**: `String!` (required) --- **`type`**: `Proceduretypeenum` ## Returns `CreateProcedure` **`procedure`**: `Procedure` ## Examples ```graphql Mutation mutation CreateProcedure($title: String!) { createProcedure(title: $title) { procedure { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "title": "string" } ``` ```json Response { "data": { "createProcedure": { "procedure": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createProcedureApproval Source: https://docs.firstresonance.io/api-reference/mutations/createProcedureApproval **mutation** `createProcedureApproval(input: CreateProcedureApprovalInput!): CreateProcedureApproval` ## Arguments **`input`**: `CreateProcedureApprovalInput!` (required) ## Returns `CreateProcedureApproval` **`approval`**: `ProcedureApproval` ## Examples ```graphql Mutation mutation CreateProcedureApproval($input: CreateProcedureApprovalInput!) { createProcedureApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "gateType": "RELEASED", "procedureId": "id" } } ``` ```json Response { "data": { "createProcedureApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createProcedureApprovalRequest **mutation** `createProcedureApprovalRequest(input: CreateProcedureApprovalRequestInput!): CreateProcedureApprovalRequest` ## Arguments **`input`**: `CreateProcedureApprovalRequestInput!` (required) ## Returns `CreateProcedureApprovalRequest` **`approvalRequest`**: `ProcedureApprovalRequest` ## Examples ```graphql Mutation mutation CreateProcedureApprovalRequest($input: CreateProcedureApprovalRequestInput!) { createProcedureApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "gateType": "RELEASED", "procedureId": "id", "roleId": "id" } } ``` ```json Response { "data": { "createProcedureApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/createProcedureApprovalRole **mutation** `createProcedureApprovalRole(input: CreateProcedureApprovalRoleInput!): CreateProcedureApprovalRole` ## Arguments **`input`**: `CreateProcedureApprovalRoleInput!` (required) ## Returns `CreateProcedureApprovalRole` **`approvalRole`**: `ProcedureApprovalRole` ## Examples ```graphql Mutation mutation CreateProcedureApprovalRole($input: CreateProcedureApprovalRoleInput!) { createProcedureApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "count": 1, "gateType": "RELEASED", "roleId": "id" } } ``` ```json Response { "data": { "createProcedureApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createProcedureVersion Source: https://docs.firstresonance.io/api-reference/mutations/createProcedureVersion Creates a new version of a procedure, allowing for version control and change tracking. **mutation** `createProcedureVersion(familyId: ID!, procedureId: ID): CreateProcedureVersion` ## Arguments **`familyId`**: `ID!` (required) --- **`procedureId`**: `ID` ## Returns `CreateProcedureVersion` **`procedure`**: `Procedure` ## Examples ```graphql Mutation mutation CreateProcedureVersion($familyId: ID!) { createProcedureVersion(familyId: $familyId) { procedure { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "familyId": "id" } ``` ```json Response { "data": { "createProcedureVersion": { "procedure": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createProject Source: https://docs.firstresonance.io/api-reference/mutations/createProject **mutation** `createProject(input: CreateProjectInput!): CreateProject` ## Arguments **`input`**: `CreateProjectInput!` (required) ## Returns `CreateProject` **`project`**: `Project` ## Examples ```graphql Mutation mutation CreateProject($input: CreateProjectInput!) { createProject(input: $input) { project { LastSessionId _created _etag _updated archived code } } } ``` ```json Variables { "input": { "code": "string", "title": "string" } } ``` ```json Response { "data": { "createProject": { "project": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } } } ``` # createPurchaseOrder Source: https://docs.firstresonance.io/api-reference/mutations/createPurchaseOrder **mutation** `createPurchaseOrder(input: CreatePurchaseOrderInput!): CreatePurchaseOrder` ## Arguments **`input`**: `CreatePurchaseOrderInput!` (required) ## Returns `CreatePurchaseOrder` **`purchaseOrder`**: `PurchaseOrder` ## Examples ```graphql Mutation mutation CreatePurchaseOrder($input: CreatePurchaseOrderInput!) { createPurchaseOrder(input: $input) { purchaseOrder { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalLevelsCount _ApprovalRequestsCount _ApprovalsCount _AssigneesCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createPurchaseOrder": { "purchaseOrder": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalLevelsCount": 1, "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1 } } } } ``` # createPurchaseOrderApproval Source: https://docs.firstresonance.io/api-reference/mutations/createPurchaseOrderApproval **mutation** `createPurchaseOrderApproval(input: CreatePurchaseOrderApprovalInput!): CreatePurchaseOrderApproval` ## Arguments **`input`**: `CreatePurchaseOrderApprovalInput!` (required) ## Returns `CreatePurchaseOrderApproval` **`approval`**: `PurchaseOrderApproval` ## Examples ```graphql Mutation mutation CreatePurchaseOrderApproval($input: CreatePurchaseOrderApprovalInput!) { createPurchaseOrderApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "purchaseOrderId": "id" } } ``` ```json Response { "data": { "createPurchaseOrderApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createPurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/createPurchaseOrderApprovalLevel **mutation** `createPurchaseOrderApprovalLevel(input: CreatePurchaseOrderApprovalLevelInput!): CreatePurchaseOrderApprovalLevel` ## Arguments **`input`**: `CreatePurchaseOrderApprovalLevelInput!` (required) ## Returns `CreatePurchaseOrderApprovalLevel` **`purchaseOrderApprovalLevel`**: `PurchaseOrderApprovalLevel` ## Examples ```graphql Mutation mutation CreatePurchaseOrderApprovalLevel($input: CreatePurchaseOrderApprovalLevelInput!) { createPurchaseOrderApprovalLevel(input: $input) { purchaseOrderApprovalLevel { LastSessionId _CandidateUsersCount _created _etag _updated approvalLevel { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } } } ``` ```json Variables { "input": { "approvalLevelId": "id", "purchaseOrderId": "id" } } ``` ```json Response { "data": { "createPurchaseOrderApprovalLevel": { "purchaseOrderApprovalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "approvalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } } ``` # createPurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createPurchaseOrderApprovalRequest **mutation** `createPurchaseOrderApprovalRequest(input: CreatePurchaseOrderApprovalRequestInput!): CreatePurchaseOrderApprovalRequest` ## Arguments **`input`**: `CreatePurchaseOrderApprovalRequestInput!` (required) ## Returns `CreatePurchaseOrderApprovalRequest` **`approvalRequest`**: `PurchaseOrderApprovalRequest` ## Examples ```graphql Mutation mutation CreatePurchaseOrderApprovalRequest($input: CreatePurchaseOrderApprovalRequestInput!) { createPurchaseOrderApprovalRequest(input: $input) { approvalRequest { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "purchaseOrderId": "id", "reviewerId": "id" } } ``` ```json Response { "data": { "createPurchaseOrderApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createPurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/mutations/createPurchaseOrderFee **mutation** `createPurchaseOrderFee(input: CreatePurchaseOrderFeeInput!): CreatePurchaseOrderFee` ## Arguments **`input`**: `CreatePurchaseOrderFeeInput!` (required) ## Returns `CreatePurchaseOrderFee` **`purchaseOrderFee`**: `PurchaseOrderFee` ## Examples ```graphql Mutation mutation CreatePurchaseOrderFee($input: CreatePurchaseOrderFeeInput!) { createPurchaseOrderFee(input: $input) { purchaseOrderFee { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "name": "string", "purchaseOrderId": "id", "value": 1.5 } } ``` ```json Response { "data": { "createPurchaseOrderFee": { "purchaseOrderFee": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/createPurchaseOrderLine Creates a new line item on a purchase order. **mutation** `createPurchaseOrderLine(input: CreatePurchaseOrderLineInput!): CreatePurchaseOrderLine` ## Arguments **`input`**: `CreatePurchaseOrderLineInput!` (required) ## Returns `CreatePurchaseOrderLine` **`purchaseOrderLine`**: `PurchaseOrderLine` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` ## Examples ```graphql Mutation mutation CreatePurchaseOrderLine($input: CreatePurchaseOrderLineInput!) { createPurchaseOrderLine(input: $input) { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } reorderedPurchaseOrderLines { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "purchaseOrderId": 1 } } ``` ```json Response { "data": { "createPurchaseOrderLine": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 }, "reorderedPurchaseOrderLines": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } ] } } } ``` # createReceipt Source: https://docs.firstresonance.io/api-reference/mutations/createReceipt **mutation** `createReceipt(input: CreateReceiptInput!): CreateReceipt` ## Arguments **`input`**: `CreateReceiptInput!` (required) ## Returns `CreateReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation CreateReceipt($input: CreateReceiptInput!) { createReceipt(input: $input) { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # createRedlineApproval Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineApproval **mutation** `createRedlineApproval(input: CreateRedlineApprovalInput!): CreateRedlineApproval` ## Arguments **`input`**: `CreateRedlineApprovalInput!` (required) ## Returns `CreateRedlineApproval` **`approval`**: `RedlineApproval` ## Examples ```graphql Mutation mutation CreateRedlineApproval($input: CreateRedlineApprovalInput!) { createRedlineApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated batchSiblings { __typename } } } } ``` ```json Variables { "input": { "redlineId": "id" } } ``` ```json Response { "data": { "createRedlineApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApproval" } ] } } } } ``` # createRedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineApprovalRequest **mutation** `createRedlineApprovalRequest(input: CreateRedlineApprovalRequestInput!): CreateRedlineApprovalRequest` ## Arguments **`input`**: `CreateRedlineApprovalRequestInput!` (required) ## Returns `CreateRedlineApprovalRequest` **`approvalRequest`**: `RedlineApprovalRequest` ## Examples ```graphql Mutation mutation CreateRedlineApprovalRequest($input: CreateRedlineApprovalRequestInput!) { createRedlineApprovalRequest(input: $input) { approvalRequest { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } } ``` ```json Variables { "input": { "redlineId": "id", "reviewerId": "id" } } ``` ```json Response { "data": { "createRedlineApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApprovalRequest" } ], "batched": "string" } } } } ``` # createRedlineApprovalRequests Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineApprovalRequests **mutation** `createRedlineApprovalRequests(input: [CreateRedlineApprovalRequestInput]): CreateRedlineApprovalRequests` ## Arguments **`input`**: `[CreateRedlineApprovalRequestInput]` ## Returns `CreateRedlineApprovalRequests` **`approvalRequests`**: `[RedlineApprovalRequest]` ## Examples ```graphql Mutation mutation CreateRedlineApprovalRequests { createRedlineApprovalRequests { approvalRequests { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } } ``` ```json Response { "data": { "createRedlineApprovalRequests": { "approvalRequests": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApprovalRequest" } ], "batched": "string" } ] } } } ``` # createRedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineApprovalRole **mutation** `createRedlineApprovalRole(input: CreateRedlineApprovalRoleInput!): CreateRedlineApprovalRole` ## Arguments **`input`**: `CreateRedlineApprovalRoleInput!` (required) ## Returns `CreateRedlineApprovalRole` **`approvalRole`**: `RedlineApprovalRole` ## Examples ```graphql Mutation mutation CreateRedlineApprovalRole($input: CreateRedlineApprovalRoleInput!) { createRedlineApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "count": 1, "gateType": "CLOSED", "roleId": "id" } } ``` ```json Response { "data": { "createRedlineApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createRedlineApprovals Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineApprovals **mutation** `createRedlineApprovals(input: [CreateRedlineApprovalInput]): CreateRedlineApprovals` ## Arguments **`input`**: `[CreateRedlineApprovalInput]` ## Returns `CreateRedlineApprovals` **`approvals`**: `[RedlineApproval]` ## Examples ```graphql Mutation mutation CreateRedlineApprovals { createRedlineApprovals { approvals { LastSessionId _RepliesCount _created _etag _updated batchSiblings { __typename } } } } ``` ```json Response { "data": { "createRedlineApprovals": { "approvals": [ { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApproval" } ] } ] } } } ``` # createRedlineRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineRoleBasedApproval **mutation** `createRedlineRoleBasedApproval(input: CreateRedlineRoleBasedApprovalInput!): CreateRedlineRoleBasedApproval` ## Arguments **`input`**: `CreateRedlineRoleBasedApprovalInput!` (required) ## Returns `CreateRedlineRoleBasedApproval` **`approval`**: `RedlineRoleBasedApproval` ## Examples ```graphql Mutation mutation CreateRedlineRoleBasedApproval($input: CreateRedlineRoleBasedApprovalInput!) { createRedlineRoleBasedApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated batched } } } ``` ```json Variables { "input": { "gateType": "CLOSED", "redlineId": "id" } } ``` ```json Response { "data": { "createRedlineRoleBasedApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batched": "string" } } } } ``` # createRedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineRoleBasedApprovalRequest **mutation** `createRedlineRoleBasedApprovalRequest(input: CreateRedlineRoleBasedApprovalRequestInput!): CreateRedlineRoleBasedApprovalRequest` ## Arguments **`input`**: `CreateRedlineRoleBasedApprovalRequestInput!` (required) ## Returns `CreateRedlineRoleBasedApprovalRequest` **`approvalRequest`**: `RedlineRoleBasedApprovalRequest` ## Examples ```graphql Mutation mutation CreateRedlineRoleBasedApprovalRequest($input: CreateRedlineRoleBasedApprovalRequestInput!) { createRedlineRoleBasedApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "gateType": "CLOSED", "redlineId": "id", "roleId": "id" } } ``` ```json Response { "data": { "createRedlineRoleBasedApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createRedlineRoleBasedApprovalRequests Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineRoleBasedApprovalRequests **mutation** `createRedlineRoleBasedApprovalRequests(input: [CreateRedlineRoleBasedApprovalRequestInput]): CreateRedlineRoleBasedApprovalRequests` ## Arguments **`input`**: `[CreateRedlineRoleBasedApprovalRequestInput]` ## Returns `CreateRedlineRoleBasedApprovalRequests` **`approvalRequests`**: `[RedlineRoleBasedApprovalRequest]` ## Examples ```graphql Mutation mutation CreateRedlineRoleBasedApprovalRequests { createRedlineRoleBasedApprovalRequests { approvalRequests { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Response { "data": { "createRedlineRoleBasedApprovalRequests": { "approvalRequests": [ { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } ] } } } ``` # createRedlineRoleBasedApprovals Source: https://docs.firstresonance.io/api-reference/mutations/createRedlineRoleBasedApprovals **mutation** `createRedlineRoleBasedApprovals(input: [CreateRedlineRoleBasedApprovalInput]): CreateRedlineRoleBasedApprovals` ## Arguments **`input`**: `[CreateRedlineRoleBasedApprovalInput]` ## Returns `CreateRedlineRoleBasedApprovals` **`approvals`**: `[RedlineRoleBasedApproval]` ## Examples ```graphql Mutation mutation CreateRedlineRoleBasedApprovals { createRedlineRoleBasedApprovals { approvals { LastSessionId _RepliesCount _created _etag _updated batched } } } ``` ```json Response { "data": { "createRedlineRoleBasedApprovals": { "approvals": [ { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batched": "string" } ] } } } ``` # createRequirement Source: https://docs.firstresonance.io/api-reference/mutations/createRequirement **mutation** `createRequirement(input: CreateRequirementInput!): CreateRequirement` ## Arguments **`input`**: `CreateRequirementInput!` (required) ## Returns `CreateRequirement` **`requirement`**: `Requirement` ## Examples ```graphql Mutation mutation CreateRequirement($input: CreateRequirementInput!) { createRequirement(input: $input) { requirement { LastSessionId _created _etag _updated content createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "content": "value", "requirementType": "QUALITY_CLAUSE", "title": "string" } } ``` ```json Response { "data": { "createRequirement": { "requirement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "content": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createReview Source: https://docs.firstresonance.io/api-reference/mutations/createReview **mutation** `createReview(input: CreateReviewInput!): CreateReview` ## Arguments **`input`**: `CreateReviewInput!` (required) ## Returns `CreateReview` **`review`**: `Review` ## Examples ```graphql Mutation mutation CreateReview($input: CreateReviewInput!) { createReview(input: $input) { review { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createReview": { "review": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createReviewRequest Source: https://docs.firstresonance.io/api-reference/mutations/createReviewRequest Creates a request for a review. **mutation** `createReviewRequest(input: ReviewRequestInput!): CreateReviewRequest` ## Arguments **`input`**: `ReviewRequestInput!` (required) ## Returns `CreateReviewRequest` **`reviewRequest`**: `ReviewRequest` ## Examples ```graphql Mutation mutation CreateReviewRequest($input: ReviewRequestInput!) { createReviewRequest(input: $input) { reviewRequest { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "procedureId": "id", "reviewerId": "id" } } ``` ```json Response { "data": { "createReviewRequest": { "reviewRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createRole Source: https://docs.firstresonance.io/api-reference/mutations/createRole **mutation** `createRole(input: CreateRoleInput!): CreateRole` ## Arguments **`input`**: `CreateRoleInput!` (required) ## Returns `CreateRole` **`role`**: `Role` ## Examples ```graphql Mutation mutation CreateRole($input: CreateRoleInput!) { createRole(input: $input) { role { LastSessionId _IssueApprovalRequestsCount _IssueApprovalsCount _IssueDispositionTypeRolesCount _PermissionGroupRolesCount _PermissionGroupsCount } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createRole": { "role": { "LastSessionId": "string", "_IssueApprovalRequestsCount": 1, "_IssueApprovalsCount": 1, "_IssueDispositionTypeRolesCount": 1, "_PermissionGroupRolesCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # createRule Source: https://docs.firstresonance.io/api-reference/mutations/createRule **mutation** `createRule(input: CreateRuleInput!): CreateRule` ## Arguments **`input`**: `CreateRuleInput!` (required) ## Returns `CreateRule` **`rule`**: `Rule` ## Examples ```graphql Mutation mutation CreateRule($input: CreateRuleInput!) { createRule(input: $input) { rule { LastSessionId _ExecutionLogsCount _created _etag _updated aiDescription } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createRule": { "rule": { "LastSessionId": "string", "_ExecutionLogsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "aiDescription": "string" } } } } ``` # createRun Source: https://docs.firstresonance.io/api-reference/mutations/createRun **mutation** `createRun(input: CreateRunInput!): CreateRun` ## Arguments **`input`**: `CreateRunInput!` (required) ## Returns `CreateRun` **`run`**: `Run` ## Examples ```graphql Mutation mutation CreateRun($input: CreateRunInput!) { createRun(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createRun": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # createRunBatch Source: https://docs.firstresonance.io/api-reference/mutations/createRunBatch **mutation** `createRunBatch(input: CreateRunBatchInput!): CreateRunBatch` ## Arguments **`input`**: `CreateRunBatchInput!` (required) ## Returns `CreateRunBatch` **`runBatch`**: `RunBatch` ## Examples ```graphql Mutation mutation CreateRunBatch($input: CreateRunBatchInput!) { createRunBatch(input: $input) { runBatch { LastSessionId _RunsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "createRunBatch": { "runBatch": { "LastSessionId": "string", "_RunsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createRunStep Source: https://docs.firstresonance.io/api-reference/mutations/createRunStep Creates a new step instance (run step) within a run. **mutation** `createRunStep(input: CreateRunStepInput!): CreateRunStep` ## Arguments **`input`**: `CreateRunStepInput!` (required) ## Returns `CreateRunStep` **`reorderedRunSteps`**: `[RunStep]` --- **`step`**: `RunStep` ## Examples ```graphql Mutation mutation CreateRunStep($input: CreateRunStepInput!) { createRunStep(input: $input) { reorderedRunSteps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "runId": "id", "title": "string" } } ``` ```json Response { "data": { "createRunStep": { "reorderedRunSteps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } ], "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } } ``` # createRunStepBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/createRunStepBuildRequirementSubstitute **mutation** `createRunStepBuildRequirementSubstitute(input: CreateRunStepBuildRequirementSubstituteInput!): CreateRunStepBuildRequirementSubstitute` ## Arguments **`input`**: `CreateRunStepBuildRequirementSubstituteInput!` (required) ## Returns `CreateRunStepBuildRequirementSubstitute` **`runStepBuildRequirementSubstitute`**: `RunStepBuildRequirementSubstitute` ## Examples ```graphql Mutation mutation CreateRunStepBuildRequirementSubstitute($input: CreateRunStepBuildRequirementSubstituteInput!) { createRunStepBuildRequirementSubstitute(input: $input) { runStepBuildRequirementSubstitute { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "buildRequirementId": 1, "partId": 1, "runStepId": 1 } } ``` ```json Response { "data": { "createRunStepBuildRequirementSubstitute": { "runStepBuildRequirementSubstitute": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } } ``` # createRunStepEdge Source: https://docs.firstresonance.io/api-reference/mutations/createRunStepEdge **mutation** `createRunStepEdge(input: CreateStepEdgeInput!): CreateRunStepEdge` ## Arguments **`input`**: `CreateStepEdgeInput!` (required) ## Returns `CreateRunStepEdge` **`stepEdge`**: `RunStepsEdge` ## Examples ```graphql Mutation mutation CreateRunStepEdge($input: CreateStepEdgeInput!) { createRunStepEdge(input: $input) { stepEdge { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } } ``` ```json Variables { "input": { "stepId": "id", "upstreamStepId": "id" } } ``` ```json Response { "data": { "createRunStepEdge": { "stepEdge": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RunStepsEdge" } ], "batched": true } } } } ``` # createRunStepField Source: https://docs.firstresonance.io/api-reference/mutations/createRunStepField **mutation** `createRunStepField(input: CreateRunStepFieldInput!): CreateRunStepField` ## Arguments **`input`**: `CreateRunStepFieldInput!` (required) ## Returns `CreateRunStepField` **`runStepField`**: `RunStepField` ## Examples ```graphql Mutation mutation CreateRunStepField($input: CreateRunStepFieldInput!) { createRunStepField(input: $input) { runStepField { LastSessionId _AssigneesCount _IonValueCount _ValidationsCount _ValueCount _created } } } ``` ```json Variables { "input": { "name": "string", "runStepId": "id", "type": "BOOLEAN" } } ``` ```json Response { "data": { "createRunStepField": { "runStepField": { "LastSessionId": "string", "_AssigneesCount": 1, "_IonValueCount": 1, "_ValidationsCount": 1, "_ValueCount": 1, "_created": "value" } } } } ``` # createRunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/mutations/createRunStepFieldValidation **mutation** `createRunStepFieldValidation(input: CreateRunStepFieldValidationInput!): CreateRunStepFieldValidation` ## Arguments **`input`**: `CreateRunStepFieldValidationInput!` (required) ## Returns `CreateRunStepFieldValidation` **`runStepFieldValidation`**: `RunStepFieldValidation` ## Examples ```graphql Mutation mutation CreateRunStepFieldValidation($input: CreateRunStepFieldValidationInput!) { createRunStepFieldValidation(input: $input) { runStepFieldValidation { LastSessionId _created _etag _updated allBatchedSiblings { __typename } batchAdoptedSiblings { __typename } } } } ``` ```json Variables { "input": { "functionId": "id", "runStepFieldId": "id" } } ``` ```json Response { "data": { "createRunStepFieldValidation": { "runStepFieldValidation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "RunStepFieldValidation" } ], "batchAdoptedSiblings": [ { "__typename": "RunStepFieldValidation" } ] } } } } ``` # createRuns Source: https://docs.firstresonance.io/api-reference/mutations/createRuns Creates one or more runs, which are executions of a procedure. **mutation** `createRuns(input: [CreateRunInput]): CreateRuns` ## Arguments **`input`**: `[CreateRunInput]` ## Returns `CreateRuns` **`runs`**: `[Run]` ## Examples ```graphql Mutation mutation CreateRuns { createRuns { runs { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "createRuns": { "runs": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # createSnapshotExportJob Source: https://docs.firstresonance.io/api-reference/mutations/createSnapshotExportJob **mutation** `createSnapshotExportJob(input: CreateSnapshotExportJobInput!): CreateSnapshotExportJob` ## Arguments **`input`**: `CreateSnapshotExportJobInput!` (required) ## Returns `CreateSnapshotExportJob` **`snapshotExportJob`**: `SnapshotExportJob` ## Examples ```graphql Mutation mutation CreateSnapshotExportJob($input: CreateSnapshotExportJobInput!) { createSnapshotExportJob(input: $input) { snapshotExportJob { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "type": "ATTACHMENTS" } } ``` ```json Response { "data": { "createSnapshotExportJob": { "snapshotExportJob": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createSsoSetupTicket Source: https://docs.firstresonance.io/api-reference/mutations/createSsoSetupTicket Generates a Self-Service SSO setup URL for the customer admin. **mutation** `createSsoSetupTicket: CreateSSOSetupTicket` ## Returns `CreateSSOSetupTicket` **`ticket`**: `SSOTicketResult` ## Examples ```graphql Mutation mutation CreateSsoSetupTicket { createSsoSetupTicket { ticket { ticketUrl } } } ``` ```json Response { "data": { "createSsoSetupTicket": { "ticket": { "ticketUrl": "string" } } } } ``` # createStandardStepVersion Source: https://docs.firstresonance.io/api-reference/mutations/createStandardStepVersion Creates a new version of a standard step, allowing for controlled updates to reusable steps. **mutation** `createStandardStepVersion(input: CreateStandardStepVersionInput!): CreateStandardStepVersion` ## Arguments **`input`**: `CreateStandardStepVersionInput!` (required) ## Returns `CreateStandardStepVersion` **`step`**: `Step` ## Examples ```graphql Mutation mutation CreateStandardStepVersion($input: CreateStandardStepVersionInput!) { createStandardStepVersion(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "familyId": 1 } } ``` ```json Response { "data": { "createStandardStepVersion": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # createStep Source: https://docs.firstresonance.io/api-reference/mutations/createStep Creates a new step within a procedure. Steps are the individual instructions within a procedure. **mutation** `createStep(input: CreateStepInput!): CreateStep` ## Arguments **`input`**: `CreateStepInput!` (required) ## Returns `CreateStep` **`step`**: `Step` ## Examples ```graphql Mutation mutation CreateStep($input: CreateStepInput!) { createStep(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "title": "string" } } ``` ```json Response { "data": { "createStep": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # createStepApproval Source: https://docs.firstresonance.io/api-reference/mutations/createStepApproval **mutation** `createStepApproval(input: CreateStepApprovalInput!): CreateStepApproval` ## Arguments **`input`**: `CreateStepApprovalInput!` (required) ## Returns `CreateStepApproval` **`approval`**: `StepApproval` ## Examples ```graphql Mutation mutation CreateStepApproval($input: CreateStepApprovalInput!) { createStepApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "stepId": "id" } } ``` ```json Response { "data": { "createStepApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createStepApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createStepApprovalRequest **mutation** `createStepApprovalRequest(input: CreateStepApprovalRequestInput!): CreateStepApprovalRequest` ## Arguments **`input`**: `CreateStepApprovalRequestInput!` (required) ## Returns `CreateStepApprovalRequest` **`approvalRequest`**: `StepApprovalRequest` ## Examples ```graphql Mutation mutation CreateStepApprovalRequest($input: CreateStepApprovalRequestInput!) { createStepApprovalRequest(input: $input) { approvalRequest { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "reviewerId": "id", "stepId": "id" } } ``` ```json Response { "data": { "createStepApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createStepApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/createStepApprovalRole **mutation** `createStepApprovalRole(input: CreateStepApprovalRoleInput!): CreateStepApprovalRole` ## Arguments **`input`**: `CreateStepApprovalRoleInput!` (required) ## Returns `CreateStepApprovalRole` **`approvalRole`**: `StepApprovalRole` ## Examples ```graphql Mutation mutation CreateStepApprovalRole($input: CreateStepApprovalRoleInput!) { createStepApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "count": 1, "gateType": "RELEASED", "roleId": "id" } } ``` ```json Response { "data": { "createStepApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createStepEdge Source: https://docs.firstresonance.io/api-reference/mutations/createStepEdge **mutation** `createStepEdge(input: CreateStepEdgeInput!): CreateStepEdge` ## Arguments **`input`**: `CreateStepEdgeInput!` (required) ## Returns `CreateStepEdge` **`stepEdge`**: `StepsEdge` ## Examples ```graphql Mutation mutation CreateStepEdge($input: CreateStepEdgeInput!) { createStepEdge(input: $input) { stepEdge { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "stepId": "id", "upstreamStepId": "id" } } ``` ```json Response { "data": { "createStepEdge": { "stepEdge": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createStepField Source: https://docs.firstresonance.io/api-reference/mutations/createStepField Creates a new field within a step. Fields are used to collect data during a run. **mutation** `createStepField(input: CreateStepFieldInput!): CreateStepField` ## Arguments **`input`**: `CreateStepFieldInput!` (required) ## Returns `CreateStepField` **`stepField`**: `StepField` ## Examples ```graphql Mutation mutation CreateStepField($input: CreateStepFieldInput!) { createStepField(input: $input) { stepField { LastSessionId _ValidationsCount _created _etag _updated allowNotApplicable } } } ``` ```json Variables { "input": { "name": "string", "stepId": "id" } } ``` ```json Response { "data": { "createStepField": { "stepField": { "LastSessionId": "string", "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allowNotApplicable": true } } } } ``` # createStepFieldValidation Source: https://docs.firstresonance.io/api-reference/mutations/createStepFieldValidation **mutation** `createStepFieldValidation(input: CreateStepFieldValidationInput!): CreateStepFieldValidation` ## Arguments **`input`**: `CreateStepFieldValidationInput!` (required) ## Returns `CreateStepFieldValidation` **`stepFieldValidation`**: `StepFieldValidation` ## Examples ```graphql Mutation mutation CreateStepFieldValidation($input: CreateStepFieldValidationInput!) { createStepFieldValidation(input: $input) { stepFieldValidation { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "fieldId": "id", "functionId": "id" } } ``` ```json Response { "data": { "createStepFieldValidation": { "stepFieldValidation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createStepPartRequirement Source: https://docs.firstresonance.io/api-reference/mutations/createStepPartRequirement **mutation** `createStepPartRequirement(input: CreateStepPartRequirementInput!): CreateStepPartRequirement` ## Arguments **`input`**: `CreateStepPartRequirementInput!` (required) ## Returns `CreateStepPartRequirement` **`stepPartRequirement`**: `StepPartRequirement` ## Examples ```graphql Mutation mutation CreateStepPartRequirement($input: CreateStepPartRequirementInput!) { createStepPartRequirement(input: $input) { stepPartRequirement { Deleted LastSessionId _AssignedReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _ReferenceDesignatorsCount } } } ``` ```json Variables { "input": { "mbomItemId": "id", "quantity": 1.5, "stepId": "id" } } ``` ```json Response { "data": { "createStepPartRequirement": { "stepPartRequirement": { "Deleted": true, "LastSessionId": "string", "_AssignedReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_ReferenceDesignatorsCount": 1 } } } } ``` # createStepProposal Source: https://docs.firstresonance.io/api-reference/mutations/createStepProposal **mutation** `createStepProposal(input: CreateStepProposalInput!): CreateStepProposal` ## Arguments **`input`**: `CreateStepProposalInput!` (required) ## Returns `CreateStepProposal` **`stepProposal`**: `StepProposal` ## Examples ```graphql Mutation mutation CreateStepProposal($input: CreateStepProposalInput!) { createStepProposal(input: $input) { stepProposal { LastSessionId _created _etag _updated acceptedEtag applicationPreview { applicable conflictMessage content slateContent title } } } } ``` ```json Variables { "input": { "changeSummary": "string", "stepId": "id" } } ``` ```json Response { "data": { "createStepProposal": { "stepProposal": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "applicable": true, "conflictMessage": "string", "content": "string", "slateContent": "value", "title": "string" } } } } } ``` # createStepRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/mutations/createStepRoleBasedApproval **mutation** `createStepRoleBasedApproval(input: CreateStepRoleBasedApprovalInput!): CreateStepRoleBasedApproval` ## Arguments **`input`**: `CreateStepRoleBasedApprovalInput!` (required) ## Returns `CreateStepRoleBasedApproval` **`approval`**: `StepRoleBasedApproval` ## Examples ```graphql Mutation mutation CreateStepRoleBasedApproval($input: CreateStepRoleBasedApprovalInput!) { createStepRoleBasedApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "gateType": "RELEASED", "stepId": "id" } } ``` ```json Response { "data": { "createStepRoleBasedApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # createStepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/createStepRoleBasedApprovalRequest **mutation** `createStepRoleBasedApprovalRequest(input: CreateStepRoleBasedApprovalRequestInput!): CreateStepRoleBasedApprovalRequest` ## Arguments **`input`**: `CreateStepRoleBasedApprovalRequestInput!` (required) ## Returns `CreateStepRoleBasedApprovalRequest` **`approvalRequest`**: `StepRoleBasedApprovalRequest` ## Examples ```graphql Mutation mutation CreateStepRoleBasedApprovalRequest($input: CreateStepRoleBasedApprovalRequestInput!) { createStepRoleBasedApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "gateType": "RELEASED", "roleId": "id", "stepId": "id" } } ``` ```json Response { "data": { "createStepRoleBasedApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # createSupplier Source: https://docs.firstresonance.io/api-reference/mutations/createSupplier **mutation** `createSupplier(input: CreateSupplierInput!): CreateSupplier` ## Arguments **`input`**: `CreateSupplierInput!` (required) ## Returns `CreateSupplier` **`supplier`**: `Supplier` ## Examples ```graphql Mutation mutation CreateSupplier($input: CreateSupplierInput!) { createSupplier(input: $input) { supplier { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createSupplier": { "supplier": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # createSupplierPart Source: https://docs.firstresonance.io/api-reference/mutations/createSupplierPart **mutation** `createSupplierPart(input: CreateSupplierPartInput!): CreateSupplierPart` ## Arguments **`input`**: `CreateSupplierPartInput!` (required) ## Returns `CreateSupplierPart` **`supplierPart`**: `SupplierPart` ## Examples ```graphql Mutation mutation CreateSupplierPart($input: CreateSupplierPartInput!) { createSupplierPart(input: $input) { supplierPart { LastSessionId _PurchaseOrderLinesCount _created _etag _updated conversionFactor } } } ``` ```json Variables { "input": { "partId": "id", "supplierId": "id", "supplierPartNumber": "string" } } ``` ```json Response { "data": { "createSupplierPart": { "supplierPart": { "LastSessionId": "string", "_PurchaseOrderLinesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "conversionFactor": 1.5 } } } } ``` # createTeam Source: https://docs.firstresonance.io/api-reference/mutations/createTeam **mutation** `createTeam(input: CreateTeamInput!): CreateTeam` ## Arguments **`input`**: `CreateTeamInput!` (required) ## Returns `CreateTeam` **`team`**: `Team` ## Examples ```graphql Mutation mutation CreateTeam($input: CreateTeamInput!) { createTeam(input: $input) { team { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "input": { "name": "string" } } ``` ```json Response { "data": { "createTeam": { "team": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # createUnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/mutations/createUnitOfMeasurement **mutation** `createUnitOfMeasurement(input: CreateUnitOfMeasurementInput!): CreateUnitOfMeasurement` ## Arguments **`input`**: `CreateUnitOfMeasurementInput!` (required) ## Returns `CreateUnitOfMeasurement` **`unitOfMeasurement`**: `UnitOfMeasurement` ## Examples ```graphql Mutation mutation CreateUnitOfMeasurement($input: CreateUnitOfMeasurementInput!) { createUnitOfMeasurement(input: $input) { unitOfMeasurement { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "type": "string" } } ``` ```json Response { "data": { "createUnitOfMeasurement": { "unitOfMeasurement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createUserSubscription Source: https://docs.firstresonance.io/api-reference/mutations/createUserSubscription Creates a subscription for a user to receive notifications about an object. **mutation** `createUserSubscription(input: CreateUserSubscriptionInput!): CreateUserSubscription` ## Arguments **`input`**: `CreateUserSubscriptionInput!` (required) ## Returns `CreateUserSubscription` **`userSubscription`**: `UserSubscription` ## Examples ```graphql Mutation mutation CreateUserSubscription($input: CreateUserSubscriptionInput!) { createUserSubscription(input: $input) { userSubscription { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "entityId": "id", "userId": "id" } } ``` ```json Response { "data": { "createUserSubscription": { "userSubscription": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # createWebhookHeader Source: https://docs.firstresonance.io/api-reference/mutations/createWebhookHeader **mutation** `createWebhookHeader(input: CreateWebhookHeaderInput!): CreateWebhookHeader` ## Arguments **`input`**: `CreateWebhookHeaderInput!` (required) ## Returns `CreateWebhookHeader` **`webhookHeader`**: `WebhookHeader` ## Examples ```graphql Mutation mutation CreateWebhookHeader($input: CreateWebhookHeaderInput!) { createWebhookHeader(input: $input) { webhookHeader { LastSessionId _WebhookReceiversCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "key": "string", "value": "string" } } ``` ```json Response { "data": { "createWebhookHeader": { "webhookHeader": { "LastSessionId": "string", "_WebhookReceiversCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # createWebhookReceiver Source: https://docs.firstresonance.io/api-reference/mutations/createWebhookReceiver **mutation** `createWebhookReceiver(input: CreateWebhookReceiverInput!): CreateWebhookReceiver` ## Arguments **`input`**: `CreateWebhookReceiverInput!` (required) ## Returns `CreateWebhookReceiver` **`webhookReceiver`**: `WebhookReceiver` ## Examples ```graphql Mutation mutation CreateWebhookReceiver($input: CreateWebhookReceiverInput!) { createWebhookReceiver(input: $input) { webhookReceiver { LastSessionId _HeadersCount _SubscriptionsCount _created _etag _updated } } } ``` ```json Variables { "input": { "name": "string", "webhookUri": "string" } } ``` ```json Response { "data": { "createWebhookReceiver": { "webhookReceiver": { "LastSessionId": "string", "_HeadersCount": 1, "_SubscriptionsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # createWebhookSubscription Source: https://docs.firstresonance.io/api-reference/mutations/createWebhookSubscription **mutation** `createWebhookSubscription(input: CreateWebhookSubscriptionInput!): CreateWebhookSubscription` ## Arguments **`input`**: `CreateWebhookSubscriptionInput!` (required) ## Returns `CreateWebhookSubscription` **`webhookSubscription`**: `WebhookSubscription` ## Examples ```graphql Mutation mutation CreateWebhookSubscription($input: CreateWebhookSubscriptionInput!) { createWebhookSubscription(input: $input) { webhookSubscription { LastSessionId _EventsCount _created _etag _updated action } } } ``` ```json Variables { "input": { "action": "CREATE", "resource": "ABOM_INSTALLATIONS" } } ``` ```json Response { "data": { "createWebhookSubscription": { "webhookSubscription": { "LastSessionId": "string", "_EventsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "action": "CREATE" } } } } ``` # deleteAbomInstallation Source: https://docs.firstresonance.io/api-reference/mutations/deleteAbomInstallation Deletes a component installation from an as-built bill of materials (aBOM). **mutation** `deleteAbomInstallation(input: DeleteABomInstallationInput!): DeleteABomInstallation` ## Arguments **`input`**: `DeleteABomInstallationInput!` (required) ## Returns `DeleteABomInstallation` **`abomInstallation`**: `ABomInstallation` ## Examples ```graphql Mutation mutation DeleteAbomInstallation($input: DeleteABomInstallationInput!) { deleteAbomInstallation(input: $input) { abomInstallation { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "buildRequirementId": 1, "partInventoryId": 1 } } ``` ```json Response { "data": { "deleteAbomInstallation": { "abomInstallation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } } ``` # deleteApiKey Source: https://docs.firstresonance.io/api-reference/mutations/deleteApiKey Deletes an existing API key. This will revoke access for any application or script using this key. **mutation** `deleteApiKey(input: APIKeyInput!): DeleteAPIKey` ## Arguments **`input`**: `APIKeyInput!` (required) ## Returns `DeleteAPIKey` **`apikey`**: `APIKeyObject` ## Examples ```graphql Mutation mutation DeleteApiKey($input: APIKeyInput!) { deleteApiKey(input: $input) { apikey { _created _etag _updated clientId clientSecret createdByApiClient { id name } } } } ``` ```json Variables { "input": { "_etag": "string", "clientId": "string" } } ``` ```json Response { "data": { "deleteApiKey": { "apikey": { "_created": "value", "_etag": "string", "_updated": "value", "clientId": "string", "clientSecret": "string", "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # deleteApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/deleteApprovalLevel Deletes an approval level. Approval levels are part of an approval workflow. **mutation** `deleteApprovalLevel(etag: String!, id: ID!): DeleteApprovalLevel` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteApprovalLevel` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteApprovalLevel($etag: String!, $id: ID!) { deleteApprovalLevel(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteApprovalLevel": { "id": 1 } } } ``` # deleteAsset Source: https://docs.firstresonance.io/api-reference/mutations/deleteAsset Deletes an asset. **mutation** `deleteAsset(input: DeleteFileAttachmentInput!): DeleteAsset` ## Arguments **`input`**: `DeleteFileAttachmentInput!` (required) ## Returns `DeleteAsset` **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` ## Examples ```graphql Mutation mutation DeleteAsset($input: DeleteFileAttachmentInput!) { deleteAsset(input: $input) { entityId fileAttachmentId } } ``` ```json Variables { "input": { "entityId": "id", "fileAttachmentId": "id" } } ``` ```json Response { "data": { "deleteAsset": { "entityId": 1, "fileAttachmentId": 1 } } } ``` # deleteBarcodePattern Source: https://docs.firstresonance.io/api-reference/mutations/deleteBarcodePattern **mutation** `deleteBarcodePattern(etag: String!, id: ID!): DeleteBarcodePattern` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteBarcodePattern` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteBarcodePattern($etag: String!, $id: ID!) { deleteBarcodePattern(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteBarcodePattern": { "id": 1 } } } ``` # deleteBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/deleteBuildRequirement **mutation** `deleteBuildRequirement(etag: String!, id: ID!): DeleteBuildRequirement` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteBuildRequirement` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteBuildRequirement($etag: String!, $id: ID!) { deleteBuildRequirement(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteBuildRequirement": { "id": 1 } } } ``` # deleteBuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/mutations/deleteBuildRequirementReferenceDesignator **mutation** `deleteBuildRequirementReferenceDesignator(etag: String!, id: ID!): DeleteBuildRequirementReferenceDesignator` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteBuildRequirementReferenceDesignator` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteBuildRequirementReferenceDesignator($etag: String!, $id: ID!) { deleteBuildRequirementReferenceDesignator(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteBuildRequirementReferenceDesignator": { "id": 1 } } } ``` # deleteBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/deleteBuildRequirementSubstitute **mutation** `deleteBuildRequirementSubstitute(etag: String!, id: ID!): DeleteBuildRequirementSubstitute` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteBuildRequirementSubstitute` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteBuildRequirementSubstitute($etag: String!, $id: ID!) { deleteBuildRequirementSubstitute(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteBuildRequirementSubstitute": { "id": 1 } } } ``` # deleteChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/deleteChangeOrder **mutation** `deleteChangeOrder(etag: String!, id: ID!): DeleteChangeOrder` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteChangeOrder` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteChangeOrder($etag: String!, $id: ID!) { deleteChangeOrder(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteChangeOrder": { "id": 1 } } } ``` # deleteChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteChangeOrderApprovalRequest **mutation** `deleteChangeOrderApprovalRequest(etag: String!, id: ID!): DeleteChangeOrderApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteChangeOrderApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteChangeOrderApprovalRequest($etag: String!, $id: ID!) { deleteChangeOrderApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteChangeOrderApprovalRequest": { "id": 1 } } } ``` # deleteChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteChangeOrderApprovalRole Deletes a role from a change order approval. **mutation** `deleteChangeOrderApprovalRole(input: DeleteChangeOrderApprovalRoleInput): DeleteChangeOrderApprovalRole` ## Arguments **`input`**: `DeleteChangeOrderApprovalRoleInput` ## Returns `DeleteChangeOrderApprovalRole` **`approvalRole`**: `ChangeOrderApprovalRole` ## Examples ```graphql Mutation mutation DeleteChangeOrderApprovalRole { deleteChangeOrderApprovalRole { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteChangeOrderApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteChargeAccount Source: https://docs.firstresonance.io/api-reference/mutations/deleteChargeAccount **mutation** `deleteChargeAccount(etag: String!, id: ID!): DeleteChargeAccount` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteChargeAccount` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteChargeAccount($etag: String!, $id: ID!) { deleteChargeAccount(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteChargeAccount": { "id": 1 } } } ``` # deleteComment Source: https://docs.firstresonance.io/api-reference/mutations/deleteComment **mutation** `deleteComment(etag: String!, id: ID!): DeleteComment` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteComment` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteComment($etag: String!, $id: ID!) { deleteComment(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteComment": { "id": 1 } } } ``` # deleteContact Source: https://docs.firstresonance.io/api-reference/mutations/deleteContact **mutation** `deleteContact(etag: String!, id: ID!): DeleteContact` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteContact` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteContact($etag: String!, $id: ID!) { deleteContact(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteContact": { "id": 1 } } } ``` # deleteCurrency Source: https://docs.firstresonance.io/api-reference/mutations/deleteCurrency **mutation** `deleteCurrency(etag: String!, id: ID!): DeleteCurrency` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteCurrency` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteCurrency($etag: String!, $id: ID!) { deleteCurrency(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteCurrency": { "id": 1 } } } ``` # deleteDatagridColumn Source: https://docs.firstresonance.io/api-reference/mutations/deleteDatagridColumn **mutation** `deleteDatagridColumn(etag: String!, id: ID!): DeleteDatagridColumn` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteDatagridColumn` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteDatagridColumn($etag: String!, $id: ID!) { deleteDatagridColumn(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteDatagridColumn": { "id": 1 } } } ``` # deleteDatagridColumns Source: https://docs.firstresonance.io/api-reference/mutations/deleteDatagridColumns Deletes columns from a datagrid. **mutation** `deleteDatagridColumns(input: DeleteDatagridEntitiesInput!): DeleteDatagridColumns` ## Arguments **`input`**: `DeleteDatagridEntitiesInput!` (required) ## Returns `DeleteDatagridColumns` **`deletedIds`**: `[Int]` --- **`entitiesModified`**: `[DatagridModifiedInfo]` ## Examples ```graphql Mutation mutation DeleteDatagridColumns($input: DeleteDatagridEntitiesInput!) { deleteDatagridColumns(input: $input) { deletedIds entitiesModified { _etag id index } } } ``` ```json Variables { "input": { "ids": [ "id" ] } } ``` ```json Response { "data": { "deleteDatagridColumns": { "deletedIds": [ 1 ], "entitiesModified": [ { "_etag": "string", "id": "id", "index": 1 } ] } } } ``` # deleteDatagridRow Source: https://docs.firstresonance.io/api-reference/mutations/deleteDatagridRow **mutation** `deleteDatagridRow(etag: String!, id: ID!): DeleteDatagridRow` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteDatagridRow` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteDatagridRow($etag: String!, $id: ID!) { deleteDatagridRow(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteDatagridRow": { "id": 1 } } } ``` # deleteDatagridRows Source: https://docs.firstresonance.io/api-reference/mutations/deleteDatagridRows Deletes rows from a datagrid. **mutation** `deleteDatagridRows(input: DeleteDatagridEntitiesInput!): DeleteDatagridRows` ## Arguments **`input`**: `DeleteDatagridEntitiesInput!` (required) ## Returns `DeleteDatagridRows` **`deletedIds`**: `[Int]` --- **`entitiesModified`**: `[DatagridModifiedInfo]` ## Examples ```graphql Mutation mutation DeleteDatagridRows($input: DeleteDatagridEntitiesInput!) { deleteDatagridRows(input: $input) { deletedIds entitiesModified { _etag id index } } } ``` ```json Variables { "input": { "ids": [ "id" ] } } ``` ```json Response { "data": { "deleteDatagridRows": { "deletedIds": [ 1 ], "entitiesModified": [ { "_etag": "string", "id": "id", "index": 1 } ] } } } ``` # deleteFileAttachment Source: https://docs.firstresonance.io/api-reference/mutations/deleteFileAttachment Deletes a file attachment. **mutation** `deleteFileAttachment(input: DeleteFileAttachmentInput!): DeleteFileAttachment` ## Arguments **`input`**: `DeleteFileAttachmentInput!` (required) ## Returns `DeleteFileAttachment` **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` ## Examples ```graphql Mutation mutation DeleteFileAttachment($input: DeleteFileAttachmentInput!) { deleteFileAttachment(input: $input) { entityId fileAttachmentId } } ``` ```json Variables { "input": { "entityId": "id", "fileAttachmentId": "id" } } ``` ```json Response { "data": { "deleteFileAttachment": { "entityId": 1, "fileAttachmentId": 1 } } } ``` # deleteFurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteFurtherActionApprovalRequest **mutation** `deleteFurtherActionApprovalRequest(etag: String!, id: ID!): DeleteFurtherActionApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteFurtherActionApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteFurtherActionApprovalRequest($etag: String!, $id: ID!) { deleteFurtherActionApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteFurtherActionApprovalRequest": { "id": 1 } } } ``` # deleteFurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteFurtherActionApprovalRole Deletes a role from a further action approval. **mutation** `deleteFurtherActionApprovalRole(input: DeleteFurtherActionApprovalRoleInput): DeleteFurtherActionApprovalRole` ## Arguments **`input`**: `DeleteFurtherActionApprovalRoleInput` ## Returns `DeleteFurtherActionApprovalRole` **`approvalRole`**: `FurtherActionApprovalRole` ## Examples ```graphql Mutation mutation DeleteFurtherActionApprovalRole { deleteFurtherActionApprovalRole { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteFurtherActionApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteFurtherActionIssue Source: https://docs.firstresonance.io/api-reference/mutations/deleteFurtherActionIssue Deletes the link between a further action and an issue. **mutation** `deleteFurtherActionIssue(input: DeleteFurtherActionIssueInput!): DeleteFurtherActionIssue` ## Arguments **`input`**: `DeleteFurtherActionIssueInput!` (required) ## Returns `DeleteFurtherActionIssue` **`furtherActionIssue`**: `FurtherActionIssue` ## Examples ```graphql Mutation mutation DeleteFurtherActionIssue($input: DeleteFurtherActionIssueInput!) { deleteFurtherActionIssue(input: $input) { furtherActionIssue { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "furtherActionId": 1, "issueId": 1 } } ``` ```json Response { "data": { "deleteFurtherActionIssue": { "furtherActionIssue": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # deleteFurtherActionPart Source: https://docs.firstresonance.io/api-reference/mutations/deleteFurtherActionPart Deletes the link between a further action and a part. **mutation** `deleteFurtherActionPart(input: DeleteFurtherActionPartInput!): DeleteFurtherActionPart` ## Arguments **`input`**: `DeleteFurtherActionPartInput!` (required) ## Returns `DeleteFurtherActionPart` **`furtherActionPart`**: `FurtherActionPart` ## Examples ```graphql Mutation mutation DeleteFurtherActionPart($input: DeleteFurtherActionPartInput!) { deleteFurtherActionPart(input: $input) { furtherActionPart { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "furtherActionId": 1, "partId": 1 } } ``` ```json Response { "data": { "deleteFurtherActionPart": { "furtherActionPart": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # deleteFurtherActionRun Source: https://docs.firstresonance.io/api-reference/mutations/deleteFurtherActionRun Deletes the link between a further action and a run. **mutation** `deleteFurtherActionRun(input: DeleteFurtherActionRunInput!): DeleteFurtherActionRun` ## Arguments **`input`**: `DeleteFurtherActionRunInput!` (required) ## Returns `DeleteFurtherActionRun` **`furtherActionRun`**: `FurtherActionRun` ## Examples ```graphql Mutation mutation DeleteFurtherActionRun($input: DeleteFurtherActionRunInput!) { deleteFurtherActionRun(input: $input) { furtherActionRun { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "furtherActionId": 1, "runId": 1 } } ``` ```json Response { "data": { "deleteFurtherActionRun": { "furtherActionRun": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # deleteIntentOption Source: https://docs.firstresonance.io/api-reference/mutations/deleteIntentOption **mutation** `deleteIntentOption(etag: String!, id: ID!): DeleteIntentOption` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteIntentOption` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteIntentOption($etag: String!, $id: ID!) { deleteIntentOption(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteIntentOption": { "id": 1 } } } ``` # deleteIssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteIssueApprovalRequest **mutation** `deleteIssueApprovalRequest(etag: String!, id: ID!): DeleteIssueApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteIssueApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteIssueApprovalRequest($etag: String!, $id: ID!) { deleteIssueApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteIssueApprovalRequest": { "id": 1 } } } ``` # deleteIssueDispositionType Source: https://docs.firstresonance.io/api-reference/mutations/deleteIssueDispositionType **mutation** `deleteIssueDispositionType(etag: String!, id: ID!): DeleteIssueDispositionType` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteIssueDispositionType` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteIssueDispositionType($etag: String!, $id: ID!) { deleteIssueDispositionType(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteIssueDispositionType": { "id": 1 } } } ``` # deleteIssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteIssueDispositionTypeRole Deletes a role from an issue disposition type. **mutation** `deleteIssueDispositionTypeRole(deleteInput: DeleteIssueDispositionTypeRoleInput): DeleteIssueDispositionTypeRole` ## Arguments **`deleteInput`**: `DeleteIssueDispositionTypeRoleInput` ## Returns `DeleteIssueDispositionTypeRole` **`issueDispositionTypeRole`**: `IssueDispositionTypeRole` ## Examples ```graphql Mutation mutation DeleteIssueDispositionTypeRole { deleteIssueDispositionTypeRole { issueDispositionTypeRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteIssueDispositionTypeRole": { "issueDispositionTypeRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteIssuePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/deleteIssuePartInventory Deletes the link between an issue and a part inventory record. **mutation** `deleteIssuePartInventory(input: DeleteIssuePartInventoryInput): DeleteIssuePartInventory` ## Arguments **`input`**: `DeleteIssuePartInventoryInput` ## Returns `DeleteIssuePartInventory` **`issuePartInventory`**: `IssuePartInventory` ## Examples ```graphql Mutation mutation DeleteIssuePartInventory { deleteIssuePartInventory { issuePartInventory { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Response { "data": { "deleteIssuePartInventory": { "issuePartInventory": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # deleteIssueRelation Source: https://docs.firstresonance.io/api-reference/mutations/deleteIssueRelation **mutation** `deleteIssueRelation(etag: String!, originIssueId: ID!, relatedIssueId: ID!): DeleteIssueRelation` ## Arguments **`etag`**: `String!` (required) --- **`originIssueId`**: `ID!` (required) --- **`relatedIssueId`**: `ID!` (required) ## Returns `DeleteIssueRelation` **`originIssueId`**: `Int` --- **`relatedIssueId`**: `Int` ## Examples ```graphql Mutation mutation DeleteIssueRelation($etag: String!, $originIssueId: ID!, $relatedIssueId: ID!) { deleteIssueRelation(etag: $etag, originIssueId: $originIssueId, relatedIssueId: $relatedIssueId) { originIssueId relatedIssueId } } ``` ```json Variables { "etag": "string", "originIssueId": "id", "relatedIssueId": "id" } ``` ```json Response { "data": { "deleteIssueRelation": { "originIssueId": 1, "relatedIssueId": 1 } } } ``` # deleteLabel Source: https://docs.firstresonance.io/api-reference/mutations/deleteLabel **mutation** `deleteLabel(etag: String!, id: ID!): DeleteLabel` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteLabel` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteLabel($etag: String!, $id: ID!) { deleteLabel(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteLabel": { "id": 1 } } } ``` # deleteLocation Source: https://docs.firstresonance.io/api-reference/mutations/deleteLocation **mutation** `deleteLocation(etag: String!, id: ID!): DeleteLocation` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteLocation` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteLocation($etag: String!, $id: ID!) { deleteLocation(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteLocation": { "id": 1 } } } ``` # deleteLocationSubtype Source: https://docs.firstresonance.io/api-reference/mutations/deleteLocationSubtype **mutation** `deleteLocationSubtype(etag: String!, id: ID!): DeleteLocationSubtype` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteLocationSubtype` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteLocationSubtype($etag: String!, $id: ID!) { deleteLocationSubtype(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteLocationSubtype": { "id": 1 } } } ``` # deleteManyAbomInstallations Source: https://docs.firstresonance.io/api-reference/mutations/deleteManyAbomInstallations Atomically removes many component installations from as-built bills of materials (aBOMs) in one request, returning the freed inventory. The whole batch rolls back if any row fails. **mutation** `deleteManyAbomInstallations(input: [DeleteABomInstallationInput]!): DeleteManyABomInstallations` ## Arguments **`input`**: `[DeleteABomInstallationInput]!` (required) ## Returns `DeleteManyABomInstallations` **`deletedInstallations`**: `[DeletedABomInstallationPair]` --- **`partInventories`**: `[PartInventory]` ## Examples ```graphql Mutation mutation DeleteManyAbomInstallations($input: [DeleteABomInstallationInput]!) { deleteManyAbomInstallations(input: $input) { deletedInstallations { buildRequirementId partInventoryId } partInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": [ { "buildRequirementId": 1, "partInventoryId": 1 } ] } ``` ```json Response { "data": { "deleteManyAbomInstallations": { "deletedInstallations": [ { "buildRequirementId": 1, "partInventoryId": 1 } ], "partInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # deleteMbom Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbom **mutation** `deleteMbom(etag: String!, id: ID!): DeleteMBom` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteMBom` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteMbom($etag: String!, $id: ID!) { deleteMbom(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteMbom": { "id": 1 } } } ``` # deleteMbomApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbomApprovalRequest **mutation** `deleteMbomApprovalRequest(etag: String!, id: ID!): DeleteMBomApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteMBomApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteMbomApprovalRequest($etag: String!, $id: ID!) { deleteMbomApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteMbomApprovalRequest": { "id": 1 } } } ``` # deleteMbomApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbomApprovalRole Deletes a role from an mBOM approval. **mutation** `deleteMbomApprovalRole(input: DeleteMBomApprovalRoleInput): DeleteMBomApprovalRole` ## Arguments **`input`**: `DeleteMBomApprovalRoleInput` ## Returns `DeleteMBomApprovalRole` **`approvalRole`**: `MBomApprovalRole` ## Examples ```graphql Mutation mutation DeleteMbomApprovalRole { deleteMbomApprovalRole { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteMbomApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteMbomChangeOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbomChangeOrderLine **mutation** `deleteMbomChangeOrderLine(etag: String!, id: ID!): DeleteMbomChangeOrderLine` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteMbomChangeOrderLine` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteMbomChangeOrderLine($etag: String!, $id: ID!) { deleteMbomChangeOrderLine(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteMbomChangeOrderLine": { "id": 1 } } } ``` # deleteMbomItem Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbomItem **mutation** `deleteMbomItem(etag: String!, id: ID!): DeleteMBomItem` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteMBomItem` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteMbomItem($etag: String!, $id: ID!) { deleteMbomItem(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteMbomItem": { "id": 1 } } } ``` # deleteMbomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbomItemReferenceDesignator **mutation** `deleteMbomItemReferenceDesignator(etag: String!, id: ID!): DeleteMBomItemReferenceDesignator` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteMBomItemReferenceDesignator` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteMbomItemReferenceDesignator($etag: String!, $id: ID!) { deleteMbomItemReferenceDesignator(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteMbomItemReferenceDesignator": { "id": 1 } } } ``` # deleteMbomSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/deleteMbomSubstitute **mutation** `deleteMbomSubstitute(etag: String!, id: ID!): DeleteMBomSubstitute` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteMBomSubstitute` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteMbomSubstitute($etag: String!, $id: ID!) { deleteMbomSubstitute(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteMbomSubstitute": { "id": 1 } } } ``` # deleteOauthApp Source: https://docs.firstresonance.io/api-reference/mutations/deleteOauthApp Delete an OAuth application registration and its Auth0 client. **mutation** `deleteOauthApp(_etag: String!, id: Int!): DeleteOAuthApp` ## Arguments **`_etag`**: `String!` (required) --- **`id`**: `Int!` (required) ## Returns `DeleteOAuthApp` **`oauthApp`**: `OAuthAppRegistrationObject` ## Examples ```graphql Mutation mutation DeleteOauthApp($_etag: String!, $id: Int!) { deleteOauthApp(_etag: $_etag, id: $id) { oauthApp { _created _etag _updated appType callbackUris { _created createdById id uri uriType } clientId } } } ``` ```json Variables { "_etag": "string", "id": 1 } ``` ```json Response { "data": { "deleteOauthApp": { "oauthApp": { "_created": "value", "_etag": "string", "_updated": "value", "appType": "string", "callbackUris": [ { "_created": "value", "createdById": 1, "id": 1, "uri": "string", "uriType": "string" } ], "clientId": "string" } } } } ``` # deleteOrganizationDomain Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationDomain **mutation** `deleteOrganizationDomain(etag: String!, id: ID!): DeleteOrganizationDomain` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteOrganizationDomain` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteOrganizationDomain($etag: String!, $id: ID!) { deleteOrganizationDomain(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteOrganizationDomain": { "id": 1 } } } ``` # deleteOrganizationFurtherActionAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationFurtherActionAttributes Deletes further action attribute definitions for the organization. **mutation** `deleteOrganizationFurtherActionAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationFurtherActionAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationFurtherActionAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationFurtherActionAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationFurtherActionAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationFurtherActionAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationGlobalUniqueSerialNumberScheme Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationGlobalUniqueSerialNumberScheme Deletes the global unique serial number scheme. **mutation** `deleteOrganizationGlobalUniqueSerialNumberScheme(input: DeleteGlobalUniqueSerialNumberSchemeSettingInput!): DeleteOrganizationGlobalUniqueSerialNumberScheme` ## Arguments **`input`**: `DeleteGlobalUniqueSerialNumberSchemeSettingInput!` (required) ## Returns `DeleteOrganizationGlobalUniqueSerialNumberScheme` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationGlobalUniqueSerialNumberScheme($input: DeleteGlobalUniqueSerialNumberSchemeSettingInput!) { deleteOrganizationGlobalUniqueSerialNumberScheme(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "name": "string" } } ``` ```json Response { "data": { "deleteOrganizationGlobalUniqueSerialNumberScheme": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationIssueAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationIssueAttributes Deletes issue attribute definitions for the organization. **mutation** `deleteOrganizationIssueAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationIssueAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationIssueAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationIssueAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationIssueAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationIssueAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationLocationAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationLocationAttributes Deletes location attribute definitions for the organization. **mutation** `deleteOrganizationLocationAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationLocationAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationLocationAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationLocationAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationLocationAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationLocationAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationMbomAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationMbomAttributes Deletes mBOM attribute definitions for the organization. **mutation** `deleteOrganizationMbomAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationMbomAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationMbomAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationMbomAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationMbomAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationMbomAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPartAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPartAttributes Deletes part attribute definitions for the organization. **mutation** `deleteOrganizationPartAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPartAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPartAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPartAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPartAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPartAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPartInventoryAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPartInventoryAttributes Deletes part inventory attribute definitions for the organization. **mutation** `deleteOrganizationPartInventoryAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPartInventoryAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPartInventoryAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPartInventoryAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPartInventoryAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPartInventoryAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPartKitAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPartKitAttributes Deletes part kit attribute definitions for the organization. **mutation** `deleteOrganizationPartKitAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPartKitAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPartKitAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPartKitAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPartKitAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPartKitAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPartKitItemAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPartKitItemAttributes Deletes part kit item attribute definitions for the organization. **mutation** `deleteOrganizationPartKitItemAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPartKitItemAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPartKitItemAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPartKitItemAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPartKitItemAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPartKitItemAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPartRevisionScheme Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPartRevisionScheme Deletes the part revision scheme for the organization. **mutation** `deleteOrganizationPartRevisionScheme(input: DeletePartRevisionSchemeSettingInput!): DeleteOrganizationPartRevisionScheme` ## Arguments **`input`**: `DeletePartRevisionSchemeSettingInput!` (required) ## Returns `DeleteOrganizationPartRevisionScheme` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPartRevisionScheme($input: DeletePartRevisionSchemeSettingInput!) { deleteOrganizationPartRevisionScheme(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "name": "string" } } ``` ```json Response { "data": { "deleteOrganizationPartRevisionScheme": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPlanAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPlanAttributes Deletes plan attribute definitions for the organization. **mutation** `deleteOrganizationPlanAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPlanAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPlanAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPlanAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPlanAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPlanAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationProcedureAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationProcedureAttributes Deletes procedure attribute definitions for the organization. **mutation** `deleteOrganizationProcedureAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationProcedureAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationProcedureAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationProcedureAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationProcedureAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationProcedureAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPurchaseOrderAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPurchaseOrderAttributes Deletes purchase order attribute definitions for the organization. **mutation** `deleteOrganizationPurchaseOrderAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPurchaseOrderAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPurchaseOrderAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPurchaseOrderAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPurchaseOrderAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPurchaseOrderAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationPurchaseOrderLineAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationPurchaseOrderLineAttributes Deletes purchase order line attribute definitions for the organization. **mutation** `deleteOrganizationPurchaseOrderLineAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationPurchaseOrderLineAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationPurchaseOrderLineAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationPurchaseOrderLineAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationPurchaseOrderLineAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationPurchaseOrderLineAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationReceiptAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationReceiptAttributes Deletes receipt attribute definitions for the organization. **mutation** `deleteOrganizationReceiptAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationReceiptAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationReceiptAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationReceiptAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationReceiptAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationReceiptAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationRunAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationRunAttributes Deletes run attribute definitions for the organization. **mutation** `deleteOrganizationRunAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationRunAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationRunAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationRunAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationRunAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationRunAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationRunStepAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationRunStepAttributes Deletes run step attribute definitions for the organization. **mutation** `deleteOrganizationRunStepAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationRunStepAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationRunStepAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationRunStepAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationRunStepAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationRunStepAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationStepAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationStepAttributes Deletes step attribute definitions for the organization. **mutation** `deleteOrganizationStepAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationStepAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationStepAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationStepAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationStepAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationStepAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deleteOrganizationSupplierAttributes Source: https://docs.firstresonance.io/api-reference/mutations/deleteOrganizationSupplierAttributes Deletes supplier attribute definitions for the organization. **mutation** `deleteOrganizationSupplierAttributes(input: DeleteAttributeSettingsInput!): DeleteOrganizationSupplierAttributes` ## Arguments **`input`**: `DeleteAttributeSettingsInput!` (required) ## Returns `DeleteOrganizationSupplierAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation DeleteOrganizationSupplierAttributes($input: DeleteAttributeSettingsInput!) { deleteOrganizationSupplierAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "deleteOrganizationSupplierAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # deletePart Source: https://docs.firstresonance.io/api-reference/mutations/deletePart **mutation** `deletePart(etag: String!, id: ID!): DeletePart` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePart` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePart($etag: String!, $id: ID!) { deletePart(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePart": { "id": 1 } } } ``` # deletePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/deletePartInventory **mutation** `deletePartInventory(etag: String!, id: ID!): DeletePartInventory` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePartInventory` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePartInventory($etag: String!, $id: ID!) { deletePartInventory(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePartInventory": { "id": 1 } } } ``` # deletePartInventoryBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/deletePartInventoryBuildRequirement Deletes a build requirement from a part inventory's as-built bill of materials (aBOM). **mutation** `deletePartInventoryBuildRequirement(input: DeletePartInventoryBuildRequirementInput!): DeletePartInventoryBuildRequirement` ## Arguments **`input`**: `DeletePartInventoryBuildRequirementInput!` (required) ## Returns `DeletePartInventoryBuildRequirement` **`partInventoryBuildRequirement`**: `PartInventoryBuildRequirement` ## Examples ```graphql Mutation mutation DeletePartInventoryBuildRequirement($input: DeletePartInventoryBuildRequirementInput!) { deletePartInventoryBuildRequirement(input: $input) { partInventoryBuildRequirement { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "buildRequirementId": 1, "partInventoryId": 1 } } ``` ```json Response { "data": { "deletePartInventoryBuildRequirement": { "partInventoryBuildRequirement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } } ``` # deletePartKit Source: https://docs.firstresonance.io/api-reference/mutations/deletePartKit **mutation** `deletePartKit(etag: String!, id: ID!): DeletePartKit` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePartKit` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePartKit($etag: String!, $id: ID!) { deletePartKit(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePartKit": { "id": 1 } } } ``` # deletePartKitItem Source: https://docs.firstresonance.io/api-reference/mutations/deletePartKitItem **mutation** `deletePartKitItem(etag: String!, id: ID!): DeletePartKitItem` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePartKitItem` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePartKitItem($etag: String!, $id: ID!) { deletePartKitItem(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePartKitItem": { "id": 1 } } } ``` # deletePartProcedure Source: https://docs.firstresonance.io/api-reference/mutations/deletePartProcedure **mutation** `deletePartProcedure(etag: String!, partId: ID!, procedureId: ID!): DeletePartProcedure` ## Arguments **`etag`**: `String!` (required) --- **`partId`**: `ID!` (required) --- **`procedureId`**: `ID!` (required) ## Returns `DeletePartProcedure` **`partId`**: `Int` --- **`procedureId`**: `Int` ## Examples ```graphql Mutation mutation DeletePartProcedure($etag: String!, $partId: ID!, $procedureId: ID!) { deletePartProcedure(etag: $etag, partId: $partId, procedureId: $procedureId) { partId procedureId } } ``` ```json Variables { "etag": "string", "partId": "id", "procedureId": "id" } ``` ```json Response { "data": { "deletePartProcedure": { "partId": 1, "procedureId": 1 } } } ``` # deletePartSubtype Source: https://docs.firstresonance.io/api-reference/mutations/deletePartSubtype **mutation** `deletePartSubtype(etag: String!, id: ID!): DeletePartSubtype` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePartSubtype` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePartSubtype($etag: String!, $id: ID!) { deletePartSubtype(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePartSubtype": { "id": 1 } } } ``` # deletePlan Source: https://docs.firstresonance.io/api-reference/mutations/deletePlan **mutation** `deletePlan(etag: String!, id: ID!): DeletePlan` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePlan` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePlan($etag: String!, $id: ID!) { deletePlan(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePlan": { "id": 1 } } } ``` # deletePlanConstraint Source: https://docs.firstresonance.io/api-reference/mutations/deletePlanConstraint **mutation** `deletePlanConstraint(etag: String!, id: ID!): DeletePlanConstraint` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePlanConstraint` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePlanConstraint($etag: String!, $id: ID!) { deletePlanConstraint(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePlanConstraint": { "id": 1 } } } ``` # deletePlanItem Source: https://docs.firstresonance.io/api-reference/mutations/deletePlanItem **mutation** `deletePlanItem(etag: String!, id: ID!): DeletePlanItem` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePlanItem` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePlanItem($etag: String!, $id: ID!) { deletePlanItem(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePlanItem": { "id": 1 } } } ``` # deletePlanItemAllocation Source: https://docs.firstresonance.io/api-reference/mutations/deletePlanItemAllocation **mutation** `deletePlanItemAllocation(childPlanItemId: ID!, etag: String!, parentPlanItemId: ID!): DeletePlanItemAllocation` ## Arguments **`childPlanItemId`**: `ID!` (required) --- **`etag`**: `String!` (required) --- **`parentPlanItemId`**: `ID!` (required) ## Returns `DeletePlanItemAllocation` **`childPlanItemId`**: `Int` --- **`parentPlanItemId`**: `Int` ## Examples ```graphql Mutation mutation DeletePlanItemAllocation($childPlanItemId: ID!, $etag: String!, $parentPlanItemId: ID!) { deletePlanItemAllocation(childPlanItemId: $childPlanItemId, etag: $etag, parentPlanItemId: $parentPlanItemId) { childPlanItemId parentPlanItemId } } ``` ```json Variables { "childPlanItemId": "id", "etag": "string", "parentPlanItemId": "id" } ``` ```json Response { "data": { "deletePlanItemAllocation": { "childPlanItemId": 1, "parentPlanItemId": 1 } } } ``` # deletePlanReservation Source: https://docs.firstresonance.io/api-reference/mutations/deletePlanReservation **mutation** `deletePlanReservation(etag: String!, id: ID!): DeletePlanReservation` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePlanReservation` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePlanReservation($etag: String!, $id: ID!) { deletePlanReservation(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePlanReservation": { "id": 1 } } } ``` # deleteProcedure Source: https://docs.firstresonance.io/api-reference/mutations/deleteProcedure Deletes a procedure. This is a permanent action and cannot be undone. **mutation** `deleteProcedure(etag: String!, id: ID!): DeleteProcedure` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteProcedure` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteProcedure($etag: String!, $id: ID!) { deleteProcedure(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteProcedure": { "id": 1 } } } ``` # deleteProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteProcedureApprovalRequest **mutation** `deleteProcedureApprovalRequest(etag: String!, id: ID!): DeleteProcedureApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteProcedureApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteProcedureApprovalRequest($etag: String!, $id: ID!) { deleteProcedureApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteProcedureApprovalRequest": { "id": 1 } } } ``` # deleteProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteProcedureApprovalRole Deletes an approval role from a procedure. Approval roles are used to define who needs to approve a procedure. **mutation** `deleteProcedureApprovalRole(input: DeleteProcedureApprovalRoleInput): DeleteProcedureApprovalRole` ## Arguments **`input`**: `DeleteProcedureApprovalRoleInput` ## Returns `DeleteProcedureApprovalRole` **`approvalRole`**: `ProcedureApprovalRole` ## Examples ```graphql Mutation mutation DeleteProcedureApprovalRole { deleteProcedureApprovalRole { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteProcedureApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteProcedureMbom Source: https://docs.firstresonance.io/api-reference/mutations/deleteProcedureMbom Deletes the manufacturing bill of materials (mBOM) associated with a procedure. **mutation** `deleteProcedureMbom(mbomId: Int!, procedureId: Int!): DeleteProcedureMBom` ## Arguments **`mbomId`**: `Int!` (required) --- **`procedureId`**: `Int!` (required) ## Returns `DeleteProcedureMBom` **`deletedStepPartRequirementIds`**: `[Int]` ## Examples ```graphql Mutation mutation DeleteProcedureMbom($mbomId: Int!, $procedureId: Int!) { deleteProcedureMbom(mbomId: $mbomId, procedureId: $procedureId) { deletedStepPartRequirementIds } } ``` ```json Variables { "mbomId": 1, "procedureId": 1 } ``` ```json Response { "data": { "deleteProcedureMbom": { "deletedStepPartRequirementIds": [ 1 ] } } } ``` # deleteProject Source: https://docs.firstresonance.io/api-reference/mutations/deleteProject **mutation** `deleteProject(etag: String!, id: ID!): DeleteProject` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteProject` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteProject($etag: String!, $id: ID!) { deleteProject(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteProject": { "id": 1 } } } ``` # deletePurchaseOrder Source: https://docs.firstresonance.io/api-reference/mutations/deletePurchaseOrder Deletes a purchase order. **mutation** `deletePurchaseOrder(etag: String!, id: ID!): DeletePurchaseOrder` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePurchaseOrder` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePurchaseOrder($etag: String!, $id: ID!) { deletePurchaseOrder(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePurchaseOrder": { "id": 1 } } } ``` # deletePurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/deletePurchaseOrderApprovalLevel **mutation** `deletePurchaseOrderApprovalLevel(etag: String!, id: ID!): DeletePurchaseOrderApprovalLevel` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePurchaseOrderApprovalLevel` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePurchaseOrderApprovalLevel($etag: String!, $id: ID!) { deletePurchaseOrderApprovalLevel(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePurchaseOrderApprovalLevel": { "id": 1 } } } ``` # deletePurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deletePurchaseOrderApprovalRequest **mutation** `deletePurchaseOrderApprovalRequest(etag: String!, id: ID!): DeletePurchaseOrderApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePurchaseOrderApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePurchaseOrderApprovalRequest($etag: String!, $id: ID!) { deletePurchaseOrderApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePurchaseOrderApprovalRequest": { "id": 1 } } } ``` # deletePurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/mutations/deletePurchaseOrderFee **mutation** `deletePurchaseOrderFee(etag: String!, id: ID!): DeletePurchaseOrderFee` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePurchaseOrderFee` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeletePurchaseOrderFee($etag: String!, $id: ID!) { deletePurchaseOrderFee(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePurchaseOrderFee": { "id": 1 } } } ``` # deletePurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/deletePurchaseOrderLine Deletes a line item from a purchase order. **mutation** `deletePurchaseOrderLine(etag: String!, id: ID!): DeletePurchaseOrderLine` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeletePurchaseOrderLine` **`id`**: `Int` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` ## Examples ```graphql Mutation mutation DeletePurchaseOrderLine($etag: String!, $id: ID!) { deletePurchaseOrderLine(etag: $etag, id: $id) { id reorderedPurchaseOrderLines { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deletePurchaseOrderLine": { "id": 1, "reorderedPurchaseOrderLines": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } ] } } } ``` # deleteReceipt Source: https://docs.firstresonance.io/api-reference/mutations/deleteReceipt **mutation** `deleteReceipt(etag: String!, id: ID!): DeleteReceipt` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteReceipt` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteReceipt($etag: String!, $id: ID!) { deleteReceipt(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteReceipt": { "id": 1 } } } ``` # deleteRedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteRedlineApprovalRequest **mutation** `deleteRedlineApprovalRequest(etag: String!, id: ID!): DeleteRedlineApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRedlineApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRedlineApprovalRequest($etag: String!, $id: ID!) { deleteRedlineApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRedlineApprovalRequest": { "id": 1 } } } ``` # deleteRedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteRedlineApprovalRole Deletes a role from a redline approval. **mutation** `deleteRedlineApprovalRole(input: DeleteRedlineApprovalRoleInput): DeleteRedlineApprovalRole` ## Arguments **`input`**: `DeleteRedlineApprovalRoleInput` ## Returns `DeleteRedlineApprovalRole` **`approvalRole`**: `RedlineApprovalRole` ## Examples ```graphql Mutation mutation DeleteRedlineApprovalRole { deleteRedlineApprovalRole { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteRedlineApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteRedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteRedlineRoleBasedApprovalRequest **mutation** `deleteRedlineRoleBasedApprovalRequest(etag: String!, id: ID!): DeleteRedlineRoleBasedApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRedlineRoleBasedApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRedlineRoleBasedApprovalRequest($etag: String!, $id: ID!) { deleteRedlineRoleBasedApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRedlineRoleBasedApprovalRequest": { "id": 1 } } } ``` # deleteRequirement Source: https://docs.firstresonance.io/api-reference/mutations/deleteRequirement **mutation** `deleteRequirement(etag: String!, id: ID!): DeleteRequirement` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRequirement` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRequirement($etag: String!, $id: ID!) { deleteRequirement(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRequirement": { "id": 1 } } } ``` # deleteReviewRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteReviewRequest **mutation** `deleteReviewRequest(etag: String!, id: ID!): DeleteReviewRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteReviewRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteReviewRequest($etag: String!, $id: ID!) { deleteReviewRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteReviewRequest": { "id": 1 } } } ``` # deleteRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteRole Deletes a role. This will also remove the role from any users or teams it is assigned to. **mutation** `deleteRole(id: Int!): DeleteRole` ## Arguments **`id`**: `Int!` (required) ## Returns `DeleteRole` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRole($id: Int!) { deleteRole(id: $id) { id } } ``` ```json Variables { "id": 1 } ``` ```json Response { "data": { "deleteRole": { "id": 1 } } } ``` # deleteRule Source: https://docs.firstresonance.io/api-reference/mutations/deleteRule **mutation** `deleteRule(etag: String!, id: ID!): DeleteRule` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRule` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRule($etag: String!, $id: ID!) { deleteRule(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRule": { "id": 1 } } } ``` # deleteRunStep Source: https://docs.firstresonance.io/api-reference/mutations/deleteRunStep **mutation** `deleteRunStep(etag: String!, id: ID!): DeleteRunStep` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRunStep` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRunStep($etag: String!, $id: ID!) { deleteRunStep(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRunStep": { "id": 1 } } } ``` # deleteRunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/deleteRunStepBuildRequirement Unmaps a build requirement from a single run step, leaving sibling steps and the aBOM unchanged. **mutation** `deleteRunStepBuildRequirement(etag: String!, id: String!): DeleteRunStepBuildRequirement` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `String!` (required) ## Returns `DeleteRunStepBuildRequirement` **`id`**: `String` ## Examples ```graphql Mutation mutation DeleteRunStepBuildRequirement($etag: String!, $id: String!) { deleteRunStepBuildRequirement(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "string" } ``` ```json Response { "data": { "deleteRunStepBuildRequirement": { "id": "string" } } } ``` # deleteRunStepBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/deleteRunStepBuildRequirementSubstitute **mutation** `deleteRunStepBuildRequirementSubstitute(etag: String!, id: ID!): DeleteRunStepBuildRequirementSubstitute` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRunStepBuildRequirementSubstitute` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRunStepBuildRequirementSubstitute($etag: String!, $id: ID!) { deleteRunStepBuildRequirementSubstitute(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRunStepBuildRequirementSubstitute": { "id": 1 } } } ``` # deleteRunStepEdge Source: https://docs.firstresonance.io/api-reference/mutations/deleteRunStepEdge **mutation** `deleteRunStepEdge(etag: String!, id: ID!): DeleteRunStepEdge` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRunStepEdge` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRunStepEdge($etag: String!, $id: ID!) { deleteRunStepEdge(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRunStepEdge": { "id": 1 } } } ``` # deleteRunStepField Source: https://docs.firstresonance.io/api-reference/mutations/deleteRunStepField **mutation** `deleteRunStepField(etag: String!, id: ID!): DeleteRunStepField` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRunStepField` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRunStepField($etag: String!, $id: ID!) { deleteRunStepField(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRunStepField": { "id": 1 } } } ``` # deleteRunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/mutations/deleteRunStepFieldValidation **mutation** `deleteRunStepFieldValidation(etag: String!, id: ID!): DeleteRunStepFieldValidation` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteRunStepFieldValidation` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteRunStepFieldValidation($etag: String!, $id: ID!) { deleteRunStepFieldValidation(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteRunStepFieldValidation": { "id": 1 } } } ``` # deleteStep Source: https://docs.firstresonance.io/api-reference/mutations/deleteStep Deletes a step from a procedure. **mutation** `deleteStep(etag: String!, id: ID!): DeleteStep` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStep` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStep($etag: String!, $id: ID!) { deleteStep(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStep": { "id": 1 } } } ``` # deleteStepApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepApprovalRequest **mutation** `deleteStepApprovalRequest(etag: String!, id: ID!): DeleteStepApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStepApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStepApprovalRequest($etag: String!, $id: ID!) { deleteStepApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStepApprovalRequest": { "id": 1 } } } ``` # deleteStepApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepApprovalRole Deletes a role from a step approval. **mutation** `deleteStepApprovalRole(input: DeleteStepApprovalRoleInput): DeleteStepApprovalRole` ## Arguments **`input`**: `DeleteStepApprovalRoleInput` ## Returns `DeleteStepApprovalRole` **`approvalRole`**: `StepApprovalRole` ## Examples ```graphql Mutation mutation DeleteStepApprovalRole { deleteStepApprovalRole { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Response { "data": { "deleteStepApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # deleteStepEdge Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepEdge **mutation** `deleteStepEdge(etag: String!, id: ID!): DeleteStepEdge` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStepEdge` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStepEdge($etag: String!, $id: ID!) { deleteStepEdge(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStepEdge": { "id": 1 } } } ``` # deleteStepField Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepField Deletes a field from a step. **mutation** `deleteStepField(etag: String!, id: ID!): DeleteStepField` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStepField` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStepField($etag: String!, $id: ID!) { deleteStepField(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStepField": { "id": 1 } } } ``` # deleteStepFieldValidation Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepFieldValidation **mutation** `deleteStepFieldValidation(etag: String!, id: ID!): DeleteStepFieldValidation` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStepFieldValidation` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStepFieldValidation($etag: String!, $id: ID!) { deleteStepFieldValidation(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStepFieldValidation": { "id": 1 } } } ``` # deleteStepPartRequirement Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepPartRequirement Deletes a part requirement from a step. **mutation** `deleteStepPartRequirement(etag: String!, id: ID!): DeleteStepPartRequirement` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStepPartRequirement` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStepPartRequirement($etag: String!, $id: ID!) { deleteStepPartRequirement(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStepPartRequirement": { "id": 1 } } } ``` # deleteStepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/deleteStepRoleBasedApprovalRequest **mutation** `deleteStepRoleBasedApprovalRequest(etag: String!, id: ID!): DeleteStepRoleBasedApprovalRequest` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteStepRoleBasedApprovalRequest` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteStepRoleBasedApprovalRequest($etag: String!, $id: ID!) { deleteStepRoleBasedApprovalRequest(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteStepRoleBasedApprovalRequest": { "id": 1 } } } ``` # deleteSupplier Source: https://docs.firstresonance.io/api-reference/mutations/deleteSupplier **mutation** `deleteSupplier(etag: String!, id: ID!): DeleteSupplier` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteSupplier` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteSupplier($etag: String!, $id: ID!) { deleteSupplier(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteSupplier": { "id": 1 } } } ``` # deleteSupplierPart Source: https://docs.firstresonance.io/api-reference/mutations/deleteSupplierPart **mutation** `deleteSupplierPart(etag: String!, id: ID!): DeleteSupplierPart` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteSupplierPart` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteSupplierPart($etag: String!, $id: ID!) { deleteSupplierPart(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteSupplierPart": { "id": 1 } } } ``` # deleteTeam Source: https://docs.firstresonance.io/api-reference/mutations/deleteTeam Deletes a team. **mutation** `deleteTeam(id: Int!): DeleteTeam` ## Arguments **`id`**: `Int!` (required) ## Returns `DeleteTeam` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteTeam($id: Int!) { deleteTeam(id: $id) { id } } ``` ```json Variables { "id": 1 } ``` ```json Response { "data": { "deleteTeam": { "id": 1 } } } ``` # deleteUnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/mutations/deleteUnitOfMeasurement **mutation** `deleteUnitOfMeasurement(etag: String!, id: ID!): DeleteUnitOfMeasurement` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteUnitOfMeasurement` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteUnitOfMeasurement($etag: String!, $id: ID!) { deleteUnitOfMeasurement(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteUnitOfMeasurement": { "id": 1 } } } ``` # deleteUserSubscription Source: https://docs.firstresonance.io/api-reference/mutations/deleteUserSubscription **mutation** `deleteUserSubscription(etag: String!, id: ID!): DeleteUserSubscription` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteUserSubscription` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteUserSubscription($etag: String!, $id: ID!) { deleteUserSubscription(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteUserSubscription": { "id": 1 } } } ``` # deleteWebhookHeader Source: https://docs.firstresonance.io/api-reference/mutations/deleteWebhookHeader **mutation** `deleteWebhookHeader(etag: String!, id: ID!): DeleteWebhookHeader` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteWebhookHeader` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteWebhookHeader($etag: String!, $id: ID!) { deleteWebhookHeader(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteWebhookHeader": { "id": 1 } } } ``` # deleteWebhookReceiver Source: https://docs.firstresonance.io/api-reference/mutations/deleteWebhookReceiver **mutation** `deleteWebhookReceiver(etag: String!, id: ID!): DeleteWebhookReceiver` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteWebhookReceiver` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteWebhookReceiver($etag: String!, $id: ID!) { deleteWebhookReceiver(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteWebhookReceiver": { "id": 1 } } } ``` # deleteWebhookSubscription Source: https://docs.firstresonance.io/api-reference/mutations/deleteWebhookSubscription **mutation** `deleteWebhookSubscription(etag: String!, id: ID!): DeleteWebhookSubscription` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DeleteWebhookSubscription` **`id`**: `Int` ## Examples ```graphql Mutation mutation DeleteWebhookSubscription($etag: String!, $id: ID!) { deleteWebhookSubscription(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "deleteWebhookSubscription": { "id": 1 } } } ``` # detachPermissionGroupFromRole Source: https://docs.firstresonance.io/api-reference/mutations/detachPermissionGroupFromRole Detaches a permission group from a role. **mutation** `detachPermissionGroupFromRole(input: PermissionGroupToRoleInput!): DetachPermissionGroupFromRole` ## Arguments **`input`**: `PermissionGroupToRoleInput!` (required) ## Returns `DetachPermissionGroupFromRole` **`role`**: `Role` ## Examples ```graphql Mutation mutation DetachPermissionGroupFromRole($input: PermissionGroupToRoleInput!) { detachPermissionGroupFromRole(input: $input) { role { LastSessionId _IssueApprovalRequestsCount _IssueApprovalsCount _IssueDispositionTypeRolesCount _PermissionGroupRolesCount _PermissionGroupsCount } } } ``` ```json Variables { "input": { "permissionGroupId": 1, "roleId": 1 } } ``` ```json Response { "data": { "detachPermissionGroupFromRole": { "role": { "LastSessionId": "string", "_IssueApprovalRequestsCount": 1, "_IssueApprovalsCount": 1, "_IssueDispositionTypeRolesCount": 1, "_PermissionGroupRolesCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # detachRoleFromTeam Source: https://docs.firstresonance.io/api-reference/mutations/detachRoleFromTeam Removes a role from a team. **mutation** `detachRoleFromTeam(input: TeamToRoleInput!): DetachRoleFromTeam` ## Arguments **`input`**: `TeamToRoleInput!` (required) ## Returns `DetachRoleFromTeam` **`roleId`**: `Int` --- **`teamId`**: `Int` ## Examples ```graphql Mutation mutation DetachRoleFromTeam($input: TeamToRoleInput!) { detachRoleFromTeam(input: $input) { roleId teamId } } ``` ```json Variables { "input": { "roleId": 1, "teamId": 1 } } ``` ```json Response { "data": { "detachRoleFromTeam": { "roleId": 1, "teamId": 1 } } } ``` # detachRoleFromUser Source: https://docs.firstresonance.io/api-reference/mutations/detachRoleFromUser Removes a role from a user, revoking the associated permissions. **mutation** `detachRoleFromUser(input: RoleToUserInput!): DetachRoleFromUser` ## Arguments **`input`**: `RoleToUserInput!` (required) ## Returns `DetachRoleFromUser` **`roleId`**: `Int` --- **`userId`**: `Int` ## Examples ```graphql Mutation mutation DetachRoleFromUser($input: RoleToUserInput!) { detachRoleFromUser(input: $input) { roleId userId } } ``` ```json Variables { "input": { "roleId": 1, "userId": "id" } } ``` ```json Response { "data": { "detachRoleFromUser": { "roleId": 1, "userId": 1 } } } ``` # disableSsoConnection Source: https://docs.firstresonance.io/api-reference/mutations/disableSsoConnection Disables the enterprise SSO connection on the organization. **mutation** `disableSsoConnection: DisableSSOConnection` ## Returns `DisableSSOConnection` **`success`**: `Boolean` ## Examples ```graphql Mutation mutation DisableSsoConnection { disableSsoConnection { success } } ``` ```json Response { "data": { "disableSsoConnection": { "success": true } } } ``` # dismissStepProposal Source: https://docs.firstresonance.io/api-reference/mutations/dismissStepProposal Marks a proposed revision dismissed, leaving its step unchanged. **mutation** `dismissStepProposal(etag: String!, id: ID!): DismissStepProposal` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `DismissStepProposal` **`stepProposal`**: `StepProposal` ## Examples ```graphql Mutation mutation DismissStepProposal($etag: String!, $id: ID!) { dismissStepProposal(etag: $etag, id: $id) { stepProposal { LastSessionId _created _etag _updated acceptedEtag applicationPreview { applicable conflictMessage content slateContent title } } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "dismissStepProposal": { "stepProposal": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "applicable": true, "conflictMessage": "string", "content": "string", "slateContent": "value", "title": "string" } } } } } ``` # dispatchNotification Source: https://docs.firstresonance.io/api-reference/mutations/dispatchNotification Dispatches a notification to users. **mutation** `dispatchNotification(input: DispatchNotificationInput!): DispatchNotification` ## Arguments **`input`**: `DispatchNotificationInput!` (required) ## Returns `DispatchNotification` **`response`**: `MessageResponse` ## Examples ```graphql Mutation mutation DispatchNotification($input: DispatchNotificationInput!) { dispatchNotification(input: $input) { response { messageId } } } ``` ```json Variables { "input": { "description": "string", "linkText": "string", "notificationType": "EXTERNAL", "path": "string", "title": "string", "userId": "id" } } ``` ```json Response { "data": { "dispatchNotification": { "response": { "messageId": "id" } } } } ``` # fulfillPickRunStop Source: https://docs.firstresonance.io/api-reference/mutations/fulfillPickRunStop Issues one stop's stock into its kits in a single transaction; all splits commit or none. **mutation** `fulfillPickRunStop(input: FulfillPickRunStopInput!): FulfillPickRunStop` ## Arguments **`input`**: `FulfillPickRunStopInput!` (required) ## Returns `FulfillPickRunStop` **`kittedInventories`**: `[PartInventory]` --- **`pickRunStop`**: `PickRunStop` ## Examples ```graphql Mutation mutation FulfillPickRunStop($input: FulfillPickRunStopInput!) { fulfillPickRunStop(input: $input) { kittedInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } pickRunStop { Created Etag LastSessionId Updated _AllocationsCount allocations { Created Etag LastSessionId Updated createdBy { __typename } createdById } } } } ``` ```json Variables { "input": { "etag": "string", "stopId": "id" } } ``` ```json Response { "data": { "fulfillPickRunStop": { "kittedInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ], "pickRunStop": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_AllocationsCount": 1, "allocations": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } ] } } } } ``` # generateProcedureExport Source: https://docs.firstresonance.io/api-reference/mutations/generateProcedureExport Starts an export of the files attached to one or more procedures and their steps. The archive is emailed to the requesting user as a download link. **mutation** `generateProcedureExport(input: GenerateProcedureExportInput!): GenerateProcedureExport` ## Arguments **`input`**: `GenerateProcedureExportInput!` (required) ## Returns `GenerateProcedureExport` **`message`**: `String` ## Examples ```graphql Mutation mutation GenerateProcedureExport($input: GenerateProcedureExportInput!) { generateProcedureExport(input: $input) { message } } ``` ```json Variables { "input": { "procedureIds": [ 1 ] } } ``` ```json Response { "data": { "generateProcedureExport": { "message": "string" } } } ``` # generateReadEmbeddedAnalytics Source: https://docs.firstresonance.io/api-reference/mutations/generateReadEmbeddedAnalytics Generates a URL to read embedded analytics. **mutation** `generateReadEmbeddedAnalytics(workbookId: String): GenerateReadEmbeddedAnalytics` ## Arguments **`workbookId`**: `String` ## Returns `GenerateReadEmbeddedAnalytics` **`embeddedAnalytics`**: `EmbeddedAnalytics` ## Examples ```graphql Mutation mutation GenerateReadEmbeddedAnalytics { generateReadEmbeddedAnalytics { embeddedAnalytics { url } } } ``` ```json Response { "data": { "generateReadEmbeddedAnalytics": { "embeddedAnalytics": { "url": "string" } } } } ``` # generateRunSummary Source: https://docs.firstresonance.io/api-reference/mutations/generateRunSummary Generates a summary of a run, which can include details about its execution. **mutation** `generateRunSummary(input: GenerateRunSummaryInput!): GenerateRunSummary` ## Arguments **`input`**: `GenerateRunSummaryInput!` (required) ## Returns `GenerateRunSummary` **`message`**: `String` ## Examples ```graphql Mutation mutation GenerateRunSummary($input: GenerateRunSummaryInput!) { generateRunSummary(input: $input) { message } } ``` ```json Variables { "input": { "runIds": [ 1 ] } } ``` ```json Response { "data": { "generateRunSummary": { "message": "string" } } } ``` # generateWriteEmbeddedAnalytics Source: https://docs.firstresonance.io/api-reference/mutations/generateWriteEmbeddedAnalytics Generates a URL to write embedded analytics. **mutation** `generateWriteEmbeddedAnalytics(workbookId: String): GenerateWriteEmbeddedAnalytics` ## Arguments **`workbookId`**: `String` ## Returns `GenerateWriteEmbeddedAnalytics` **`embeddedAnalytics`**: `EmbeddedAnalytics` ## Examples ```graphql Mutation mutation GenerateWriteEmbeddedAnalytics { generateWriteEmbeddedAnalytics { embeddedAnalytics { url } } } ``` ```json Response { "data": { "generateWriteEmbeddedAnalytics": { "embeddedAnalytics": { "url": "string" } } } } ``` # importKitItems Source: https://docs.firstresonance.io/api-reference/mutations/importKitItems Import kit items from structured inputs. **mutation** `importKitItems(input: ImportKitItemsInput!): ImportKitItems` ## Arguments **`input`**: `ImportKitItemsInput!` (required) ## Returns `ImportKitItems` **`createdPartKitItemIds`**: `[Int]!` --- **`errors`**: `[ImportKitItemsError]!` --- **`updatedKitIds`**: `[Int]!` --- **`updatedPartKitItemIds`**: `[Int]!` ## Examples ```graphql Mutation mutation ImportKitItems($input: ImportKitItemsInput!) { importKitItems(input: $input) { createdPartKitItemIds errors { message row } updatedKitIds updatedPartKitItemIds } } ``` ```json Variables { "input": { "items": [ { "kitId": 1, "partNumber": "string", "quantity": "value" } ] } } ``` ```json Response { "data": { "importKitItems": { "createdPartKitItemIds": [ 1 ], "errors": [ { "message": "string", "row": 1 } ], "updatedKitIds": [ 1 ], "updatedPartKitItemIds": [ 1 ] } } } ``` # importKitItemsCsv Source: https://docs.firstresonance.io/api-reference/mutations/importKitItemsCsv Import kit items from a CSV uploaded to S3. **mutation** `importKitItemsCsv(input: ImportKitItemsCsvInput!): ImportKitItemsCsv` ## Arguments **`input`**: `ImportKitItemsCsvInput!` (required) ## Returns `ImportKitItemsCsv` **`createdPartKitItemIds`**: `[Int]!` --- **`errors`**: `[ImportKitItemsError]!` --- **`updatedKitIds`**: `[Int]!` --- **`updatedPartKitItemIds`**: `[Int]!` ## Examples ```graphql Mutation mutation ImportKitItemsCsv($input: ImportKitItemsCsvInput!) { importKitItemsCsv(input: $input) { createdPartKitItemIds errors { message row } updatedKitIds updatedPartKitItemIds } } ``` ```json Variables { "input": { "s3Key": "string" } } ``` ```json Response { "data": { "importKitItemsCsv": { "createdPartKitItemIds": [ 1 ], "errors": [ { "message": "string", "row": 1 } ], "updatedKitIds": [ 1 ], "updatedPartKitItemIds": [ 1 ] } } } ``` # importStepsFromPdf Source: https://docs.firstresonance.io/api-reference/mutations/importStepsFromPdf Imports steps from a PDF document into a procedure. **mutation** `importStepsFromPdf(input: ImportStepsFromPDFInput!): ImportStepsFromPDF` ## Arguments **`input`**: `ImportStepsFromPDFInput!` (required) ## Returns `ImportStepsFromPDF` **`steps`**: `[Step]` ## Examples ```graphql Mutation mutation ImportStepsFromPdf($input: ImportStepsFromPDFInput!) { importStepsFromPdf(input: $input) { steps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "pdfAssetId": "id", "procedureId": "id" } } ``` ```json Response { "data": { "importStepsFromPdf": { "steps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } ] } } } ``` # installKitOnAbom Source: https://docs.firstresonance.io/api-reference/mutations/installKitOnAbom Installs a pre-defined kit of parts onto an as-built bill of materials (aBOM). **mutation** `installKitOnAbom(input: InstallKitOnABomInput!): InstallKitOnABom` ## Arguments **`input`**: `InstallKitOnABomInput!` (required) ## Returns `InstallKitOnABom` **`abomInstallations`**: `[ABomInstallation]` ## Examples ```graphql Mutation mutation InstallKitOnAbom($input: InstallKitOnABomInput!) { installKitOnAbom(input: $input) { abomInstallations { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "etag": "string", "partInventoryId": 1, "partKitId": 1 } } ``` ```json Response { "data": { "installKitOnAbom": { "abomInstallations": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } ] } } } ``` # inviteOrganizationMember Source: https://docs.firstresonance.io/api-reference/mutations/inviteOrganizationMember Sends an Auth0 Organization invitation email to a new member. **mutation** `inviteOrganizationMember(input: InviteOrganizationMemberInput!): InviteOrganizationMember` ## Arguments **`input`**: `InviteOrganizationMemberInput!` (required) ## Returns `InviteOrganizationMember` **`invitationId`**: `String` --- **`success`**: `Boolean` ## Examples ```graphql Mutation mutation InviteOrganizationMember($input: InviteOrganizationMemberInput!) { inviteOrganizationMember(input: $input) { invitationId success } } ``` ```json Variables { "input": { "auth0OrgId": "string", "inviteeEmail": "string" } } ``` ```json Response { "data": { "inviteOrganizationMember": { "invitationId": "string", "success": true } } } ``` # issueItemToKit Source: https://docs.firstresonance.io/api-reference/mutations/issueItemToKit Issues an item from inventory to a kit. Kitting is the process of gathering parts for a specific build. **mutation** `issueItemToKit(input: InventoryToKitInput): IssueItemToKit` ## Arguments **`input`**: `InventoryToKitInput` ## Returns `IssueItemToKit` **`partInventory`**: `PartInventory` --- **`splitInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation IssueItemToKit { issueItemToKit { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } splitInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "issueItemToKit": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 }, "splitInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # linkOrganizationToAuth0 Source: https://docs.firstresonance.io/api-reference/mutations/linkOrganizationToAuth0 Links an existing customer organization to a new Auth0 Organization. Idempotent. FR admin only. **mutation** `linkOrganizationToAuth0(input: LinkOrganizationToAuth0Input!): LinkOrganizationToAuth0` ## Arguments **`input`**: `LinkOrganizationToAuth0Input!` (required) ## Returns `LinkOrganizationToAuth0` **`organization`**: `LinkOrganizationToAuth0Result` ## Examples ```graphql Mutation mutation LinkOrganizationToAuth0($input: LinkOrganizationToAuth0Input!) { linkOrganizationToAuth0(input: $input) { organization { auth0OrgId domain id } } } ``` ```json Variables { "input": { "domain": "string" } } ``` ```json Response { "data": { "linkOrganizationToAuth0": { "organization": { "auth0OrgId": "string", "domain": "string", "id": 1 } } } } ``` # linkRunStepToPurchaseOrder Source: https://docs.firstresonance.io/api-reference/mutations/linkRunStepToPurchaseOrder Links an OSP run step to a purchase order, routing to the correct PO line automatically. **mutation** `linkRunStepToPurchaseOrder(input: LinkRunStepToPurchaseOrderInput!): LinkRunStepToPurchaseOrder` ## Arguments **`input`**: `LinkRunStepToPurchaseOrderInput!` (required) ## Returns `LinkRunStepToPurchaseOrder` **`purchaseOrderLine`**: `PurchaseOrderLine` ## Examples ```graphql Mutation mutation LinkRunStepToPurchaseOrder($input: LinkRunStepToPurchaseOrderInput!) { linkRunStepToPurchaseOrder(input: $input) { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "purchaseOrderId": "id", "runStepId": 1 } } ``` ```json Response { "data": { "linkRunStepToPurchaseOrder": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # mergeMultiplePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/mergeMultiplePartInventory Bulk-merges freed part inventory lots into their merge groups (V2), one merge per group. No-op unless inventory merging is enabled for the organization. **mutation** `mergeMultiplePartInventory(input: MergeMultiplePartInventoryInput): MergeMultiplePartInventory` ## Arguments **`input`**: `MergeMultiplePartInventoryInput` ## Returns `MergeMultiplePartInventory` **`partInventories`**: `[PartInventory]` --- **`partInventoryIds`**: `[Int]` ## Examples ```graphql Mutation mutation MergeMultiplePartInventory { mergeMultiplePartInventory { partInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } partInventoryIds } } ``` ```json Response { "data": { "mergeMultiplePartInventory": { "partInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ], "partInventoryIds": [ 1 ] } } } ``` # mergePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/mergePartInventory Merges multiple part inventory records into one. **mutation** `mergePartInventory(input: MergePartInventoryInput): MergePartInventory` ## Arguments **`input`**: `MergePartInventoryInput` ## Returns `MergePartInventory` **`partInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation MergePartInventory { mergePartInventory { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "mergePartInventory": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # mergePartInventoryV2 Source: https://docs.firstresonance.io/api-reference/mutations/mergePartInventoryV2 Merges multiple part inventory records into one (V2). **mutation** `mergePartInventoryV2(input: MergePartInventoryV2Input): MergePartInventoryV2` ## Arguments **`input`**: `MergePartInventoryV2Input` ## Returns `MergePartInventoryV2` **`partInventory`**: `PartInventory` --- **`partInventoryIds`**: `[Int]` ## Examples ```graphql Mutation mutation MergePartInventoryV2 { mergePartInventoryV2 { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } partInventoryIds } } ``` ```json Response { "data": { "mergePartInventoryV2": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 }, "partInventoryIds": [ 1 ] } } } ``` # mergeRunStep Source: https://docs.firstresonance.io/api-reference/mutations/mergeRunStep (Deprecated) Merge run step into procedure step. This mutation has been deprecated in favor of MergeRunStepToProcedure. **mutation** `mergeRunStep(input: MergeRunStepInput!): MergeRunStep` > Deprecated: Renamed MergeRunStepToProcedure to avoid confusion with a new merging mutation: MergeRunStepToRuns. ## Arguments **`input`**: `MergeRunStepInput!` (required) ## Returns `MergeRunStep` **`step`**: `Step` ## Examples ```graphql Mutation mutation MergeRunStep($input: MergeRunStepInput!) { mergeRunStep(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "id": "id", "procedureId": "id" } } ``` ```json Response { "data": { "mergeRunStep": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # mergeRunStepToProcedure Source: https://docs.firstresonance.io/api-reference/mutations/mergeRunStepToProcedure Merges changes from a run step back into the source procedure. **mutation** `mergeRunStepToProcedure(input: MergeRunStepToProcedureInput!): MergeRunStepToProcedure` ## Arguments **`input`**: `MergeRunStepToProcedureInput!` (required) ## Returns `MergeRunStepToProcedure` **`step`**: `Step` ## Examples ```graphql Mutation mutation MergeRunStepToProcedure($input: MergeRunStepToProcedureInput!) { mergeRunStepToProcedure(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "id": "id", "procedureId": "id" } } ``` ```json Response { "data": { "mergeRunStepToProcedure": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # mergeRunStepToRuns Source: https://docs.firstresonance.io/api-reference/mutations/mergeRunStepToRuns Merges changes from a run step to other runs of the same procedure. **mutation** `mergeRunStepToRuns(input: MergeRunStepToRunsInput!): MergeRunStepToRuns` ## Arguments **`input`**: `MergeRunStepToRunsInput!` (required) ## Returns `MergeRunStepToRuns` **`steps`**: `[RunStep]` ## Examples ```graphql Mutation mutation MergeRunStepToRuns($input: MergeRunStepToRunsInput!) { mergeRunStepToRuns(input: $input) { steps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "id": "id", "runs": [ { "runId": "id" } ] } } ``` ```json Response { "data": { "mergeRunStepToRuns": { "steps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } ] } } } ``` # moveItemToInventory Source: https://docs.firstresonance.io/api-reference/mutations/moveItemToInventory Moves an item to a new inventory location. **mutation** `moveItemToInventory(input: InventoryToKitInput): MoveItemToInventory` ## Arguments **`input`**: `InventoryToKitInput` ## Returns `MoveItemToInventory` **`partInventory`**: `PartInventory` --- **`splitInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation MoveItemToInventory { moveItemToInventory { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } splitInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "moveItemToInventory": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 }, "splitInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # moveKitInventoryToLocation Source: https://docs.firstresonance.io/api-reference/mutations/moveKitInventoryToLocation Moves the inventory for a kit to a new location. **mutation** `moveKitInventoryToLocation(input: MoveKitInventoryToLocationInput!): MoveKitInventoryToLocation` ## Arguments **`input`**: `MoveKitInventoryToLocationInput!` (required) ## Returns `MoveKitInventoryToLocation` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation MoveKitInventoryToLocation($input: MoveKitInventoryToLocationInput!) { moveKitInventoryToLocation(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": { "etag": "string", "locationId": "id", "partKitId": "id" } } ``` ```json Response { "data": { "moveKitInventoryToLocation": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # provisionCustomer Source: https://docs.firstresonance.io/api-reference/mutations/provisionCustomer Provisions a new customer: DB schema, ION org, and Auth0 org. **mutation** `provisionCustomer(input: ProvisionCustomerInput!): ProvisionCustomer` ## Arguments **`input`**: `ProvisionCustomerInput!` (required) ## Returns `ProvisionCustomer` **`organization`**: `ProvisionCustomerResult` ## Examples ```graphql Mutation mutation ProvisionCustomer($input: ProvisionCustomerInput!) { provisionCustomer(input: $input) { organization { auth0OrgId domain id } } } ``` ```json Variables { "input": { "displayName": "string", "domain": "string" } } ``` ```json Response { "data": { "provisionCustomer": { "organization": { "auth0OrgId": "string", "domain": "string", "id": 1 } } } } ``` # recomputeMbomChangeOrderLineDiffs Source: https://docs.firstresonance.io/api-reference/mutations/recomputeMbomChangeOrderLineDiffs Restates a draft change order's diffs against the inventories as they are now, keeping every resolution whose diff survived. Draft only. **mutation** `recomputeMbomChangeOrderLineDiffs(input: RecomputeMbomChangeOrderLineDiffsInput!): RecomputeMbomChangeOrderLineDiffs` ## Arguments **`input`**: `RecomputeMbomChangeOrderLineDiffsInput!` (required) ## Returns `RecomputeMbomChangeOrderLineDiffs` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation RecomputeMbomChangeOrderLineDiffs($input: RecomputeMbomChangeOrderLineDiffsInput!) { recomputeMbomChangeOrderLineDiffs(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "changeOrderId": 1, "etag": "string", "mbomChangeOrderLineIds": [ 1 ] } } ``` ```json Response { "data": { "recomputeMbomChangeOrderLineDiffs": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # registerOauthApp Source: https://docs.firstresonance.io/api-reference/mutations/registerOauthApp Register a new OAuth application for the organization. **mutation** `registerOauthApp(appType: String!, name: String!): RegisterOAuthApp` ## Arguments **`appType`**: `String!` (required) --- **`name`**: `String!` (required) ## Returns `RegisterOAuthApp` **`oauthApp`**: `OAuthAppRegistrationObject` ## Examples ```graphql Mutation mutation RegisterOauthApp($appType: String!, $name: String!) { registerOauthApp(appType: $appType, name: $name) { oauthApp { _created _etag _updated appType callbackUris { _created createdById id uri uriType } clientId } } } ``` ```json Variables { "appType": "string", "name": "string" } ``` ```json Response { "data": { "registerOauthApp": { "oauthApp": { "_created": "value", "_etag": "string", "_updated": "value", "appType": "string", "callbackUris": [ { "_created": "value", "createdById": 1, "id": 1, "uri": "string", "uriType": "string" } ], "clientId": "string" } } } } ``` # removeAllInventoryFromKit Source: https://docs.firstresonance.io/api-reference/mutations/removeAllInventoryFromKit Removes all inventory that has been allocated to a kit. **mutation** `removeAllInventoryFromKit(input: RemoveAllInventoryFromKitInput!): RemoveAllInventoryFromKit` ## Arguments **`input`**: `RemoveAllInventoryFromKitInput!` (required) ## Returns `RemoveAllInventoryFromKit` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation RemoveAllInventoryFromKit($input: RemoveAllInventoryFromKitInput!) { removeAllInventoryFromKit(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "removeAllInventoryFromKit": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # removeAssetFromItem Source: https://docs.firstresonance.io/api-reference/mutations/removeAssetFromItem Removes an asset association from an item without deleting the file attachment. **mutation** `removeAssetFromItem(input: AssetToItemInput!): RemoveAssetFromItem` ## Arguments **`input`**: `AssetToItemInput!` (required) ## Returns `RemoveAssetFromItem` **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` ## Examples ```graphql Mutation mutation RemoveAssetFromItem($input: AssetToItemInput!) { removeAssetFromItem(input: $input) { entity { Updated assets { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } comments { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } fileAttachments { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } id } entityId fileAttachmentId } } ``` ```json Variables { "input": { "entityId": "id", "fileAttachmentId": "id" } } ``` ```json Response { "data": { "removeAssetFromItem": { "entity": { "Updated": "value", "assets": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ], "comments": [ { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } ], "fileAttachments": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "id": 1.5 }, "entityId": 1, "fileAttachmentId": 1 } } } ``` # removeHeaderFromWebhookReceiver Source: https://docs.firstresonance.io/api-reference/mutations/removeHeaderFromWebhookReceiver Removes a header from a webhook receiver configuration. **mutation** `removeHeaderFromWebhookReceiver(input: WebhookReceiverHeaderInput): RemoveHeaderFromWebhookReceiver` ## Arguments **`input`**: `WebhookReceiverHeaderInput` ## Returns `RemoveHeaderFromWebhookReceiver` **`webhookReceiver`**: `WebhookReceiver` ## Examples ```graphql Mutation mutation RemoveHeaderFromWebhookReceiver { removeHeaderFromWebhookReceiver { webhookReceiver { LastSessionId _HeadersCount _SubscriptionsCount _created _etag _updated } } } ``` ```json Response { "data": { "removeHeaderFromWebhookReceiver": { "webhookReceiver": { "LastSessionId": "string", "_HeadersCount": 1, "_SubscriptionsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # removeInputFromPlan Source: https://docs.firstresonance.io/api-reference/mutations/removeInputFromPlan **mutation** `removeInputFromPlan(etag: String!, id: ID!): RemoveInputFromPlan` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `RemoveInputFromPlan` **`id`**: `Int` ## Examples ```graphql Mutation mutation RemoveInputFromPlan($etag: String!, $id: ID!) { removeInputFromPlan(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "removeInputFromPlan": { "id": 1 } } } ``` # removeInventoryFromPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/removeInventoryFromPurchaseOrderLine Removes inventory from a purchase order line item. **mutation** `removeInventoryFromPurchaseOrderLine(input: PurchaseOrderLineToInventoryInput): RemoveInventoryFromPurchaseOrderLine` ## Arguments **`input`**: `PurchaseOrderLineToInventoryInput` ## Returns `RemoveInventoryFromPurchaseOrderLine` **`purchaseOrderLine`**: `PurchaseOrderLine` ## Examples ```graphql Mutation mutation RemoveInventoryFromPurchaseOrderLine { removeInventoryFromPurchaseOrderLine { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "removeInventoryFromPurchaseOrderLine": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # removeInventoryFromReceipt Source: https://docs.firstresonance.io/api-reference/mutations/removeInventoryFromReceipt Remove inventory from receipt. **mutation** `removeInventoryFromReceipt(input: RemoveInventoryFromReceiptInput): RemoveInventoryFromReceipt` > Deprecated: Use RemoveItemFromReceipt instead, which allows for both part and non-part items to be removed from a receipt. ## Arguments **`input`**: `RemoveInventoryFromReceiptInput` ## Returns `RemoveInventoryFromReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation RemoveInventoryFromReceipt { removeInventoryFromReceipt { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "removeInventoryFromReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # removeItemFromReceipt Source: https://docs.firstresonance.io/api-reference/mutations/removeItemFromReceipt Removes an item from a receipt. **mutation** `removeItemFromReceipt(input: RemoveItemFromReceiptInput): RemoveItemFromReceipt` ## Arguments **`input`**: `RemoveItemFromReceiptInput` ## Returns `RemoveItemFromReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation RemoveItemFromReceipt { removeItemFromReceipt { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "removeItemFromReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # removeLabelFromItem Source: https://docs.firstresonance.io/api-reference/mutations/removeLabelFromItem Removes a label from an item. **mutation** `removeLabelFromItem(input: LabelToItemInput!): RemoveLabelFromItem` ## Arguments **`input`**: `LabelToItemInput!` (required) ## Returns `RemoveLabelFromItem` **`entityId`**: `Int` --- **`labelId`**: `Int` ## Examples ```graphql Mutation mutation RemoveLabelFromItem($input: LabelToItemInput!) { removeLabelFromItem(input: $input) { entityId labelId } } ``` ```json Variables { "input": { "entityId": 1, "labelId": 1 } } ``` ```json Response { "data": { "removeLabelFromItem": { "entityId": 1, "labelId": 1 } } } ``` # removeLabelFromProcedureFamily Source: https://docs.firstresonance.io/api-reference/mutations/removeLabelFromProcedureFamily Removes a label from a procedure family. **mutation** `removeLabelFromProcedureFamily(input: LabelToProcedureFamilyInput!): RemoveLabelFromProcedureFamily` ## Arguments **`input`**: `LabelToProcedureFamilyInput!` (required) ## Returns `RemoveLabelFromProcedureFamily` **`familyId`**: `Int` --- **`labelId`**: `Int` ## Examples ```graphql Mutation mutation RemoveLabelFromProcedureFamily($input: LabelToProcedureFamilyInput!) { removeLabelFromProcedureFamily(input: $input) { familyId labelId } } ``` ```json Variables { "input": { "familyId": 1, "labelId": 1 } } ``` ```json Response { "data": { "removeLabelFromProcedureFamily": { "familyId": 1, "labelId": 1 } } } ``` # removeOauthRedirectUri Source: https://docs.firstresonance.io/api-reference/mutations/removeOauthRedirectUri Remove a callback URL or allowed origin from an OAuth app. **mutation** `removeOauthRedirectUri(id: Int!): RemoveOAuthRedirectUri` ## Arguments **`id`**: `Int!` (required) ## Returns `RemoveOAuthRedirectUri` **`success`**: `Boolean` ## Examples ```graphql Mutation mutation RemoveOauthRedirectUri($id: Int!) { removeOauthRedirectUri(id: $id) { success } } ``` ```json Variables { "id": 1 } ``` ```json Response { "data": { "removeOauthRedirectUri": { "success": true } } } ``` # removePartInventoryFromRunStep Source: https://docs.firstresonance.io/api-reference/mutations/removePartInventoryFromRunStep Removes a part from a run step, returning it to inventory. **mutation** `removePartInventoryFromRunStep(input: RemovePartInventoryFromRunStepInput!): RemovePartInventoryFromRunStep` ## Arguments **`input`**: `RemovePartInventoryFromRunStepInput!` (required) ## Returns `RemovePartInventoryFromRunStep` **`runStep`**: `RunStep` ## Examples ```graphql Mutation mutation RemovePartInventoryFromRunStep($input: RemovePartInventoryFromRunStepInput!) { removePartInventoryFromRunStep(input: $input) { runStep { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "etag": "string", "partInventoryId": "id", "runStepId": "id" } } ``` ```json Response { "data": { "removePartInventoryFromRunStep": { "runStep": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } } ``` # removePlanItemFromPlan Source: https://docs.firstresonance.io/api-reference/mutations/removePlanItemFromPlan Removes an item from a plan. **mutation** `removePlanItemFromPlan(input: PlanItemToPlanInput): RemovePlanItemFromPlan` ## Arguments **`input`**: `PlanItemToPlanInput` ## Returns `RemovePlanItemFromPlan` **`plan`**: `Plan` ## Examples ```graphql Mutation mutation RemovePlanItemFromPlan { removePlanItemFromPlan { plan { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "removePlanItemFromPlan": { "plan": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # removeRequirementFromItem Source: https://docs.firstresonance.io/api-reference/mutations/removeRequirementFromItem Removes a requirement from an item. **mutation** `removeRequirementFromItem(input: RequirementToItemInput!): RemoveRequirementFromItem` ## Arguments **`input`**: `RequirementToItemInput!` (required) ## Returns `RemoveRequirementFromItem` **`entityId`**: `Int` --- **`requirementId`**: `Int` ## Examples ```graphql Mutation mutation RemoveRequirementFromItem($input: RequirementToItemInput!) { removeRequirementFromItem(input: $input) { entityId requirementId } } ``` ```json Variables { "input": { "entityId": 1, "requirementId": 1 } } ``` ```json Response { "data": { "removeRequirementFromItem": { "entityId": 1, "requirementId": 1 } } } ``` # removeResultFromPlanItem Source: https://docs.firstresonance.io/api-reference/mutations/removeResultFromPlanItem Removes a result from a plan item. **mutation** `removeResultFromPlanItem(input: ResultToPlanItemInput): RemoveResultFromPlanItem` ## Arguments **`input`**: `ResultToPlanItemInput` ## Returns `RemoveResultFromPlanItem` **`planItem`**: `PlanItem` ## Examples ```graphql Mutation mutation RemoveResultFromPlanItem { removeResultFromPlanItem { planItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } } ``` ```json Response { "data": { "removeResultFromPlanItem": { "planItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } } } ``` # removeSubtypeFromPart Source: https://docs.firstresonance.io/api-reference/mutations/removeSubtypeFromPart Removes a subtype from a part. **mutation** `removeSubtypeFromPart(input: PartSubtypeToPartInput): RemoveSubtypeFromPart` ## Arguments **`input`**: `PartSubtypeToPartInput` ## Returns `RemoveSubtypeFromPart` **`part`**: `Part` ## Examples ```graphql Mutation mutation RemoveSubtypeFromPart { removeSubtypeFromPart { part { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } } ``` ```json Response { "data": { "removeSubtypeFromPart": { "part": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } } } } ``` # removeUserFromTeam Source: https://docs.firstresonance.io/api-reference/mutations/removeUserFromTeam Removes a user from a team. **mutation** `removeUserFromTeam(input: TeamToUserInput!): RemoveUserFromTeam` ## Arguments **`input`**: `TeamToUserInput!` (required) ## Returns `RemoveUserFromTeam` **`teamId`**: `Int` --- **`userId`**: `Int` ## Examples ```graphql Mutation mutation RemoveUserFromTeam($input: TeamToUserInput!) { removeUserFromTeam(input: $input) { teamId userId } } ``` ```json Variables { "input": { "teamId": 1, "userId": 1 } } ``` ```json Response { "data": { "removeUserFromTeam": { "teamId": 1, "userId": 1 } } } ``` # reopenChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/reopenChangeOrder Reopens a canceled or completed change order as a draft. Lines keep their stamps, so the ones already applied or canceled stay that way, and diffs keep their recorded values. **mutation** `reopenChangeOrder(input: ChangeOrderStatusTransitionInput!): ReopenChangeOrder` ## Arguments **`input`**: `ChangeOrderStatusTransitionInput!` (required) ## Returns `ReopenChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation ReopenChangeOrder($input: ChangeOrderStatusTransitionInput!) { reopenChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "reopenChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # reorderApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/reorderApprovalLevel Changes the order of an approval level in an approval workflow. **mutation** `reorderApprovalLevel(input: ReorderApprovalLevelInput!): ReorderApprovalLevel` ## Arguments **`input`**: `ReorderApprovalLevelInput!` (required) ## Returns `ReorderApprovalLevel` **`approvalLevels`**: `[ApprovalLevel]` ## Examples ```graphql Mutation mutation ReorderApprovalLevel($input: ReorderApprovalLevelInput!) { reorderApprovalLevel(input: $input) { approvalLevels { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } } ``` ```json Variables { "input": {} } ``` ```json Response { "data": { "reorderApprovalLevel": { "approvalLevels": [ { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ] } } } ``` # reorderDatagridColumn Source: https://docs.firstresonance.io/api-reference/mutations/reorderDatagridColumn Changes the order of columns in a datagrid. **mutation** `reorderDatagridColumn(input: ReorderDatagridInput!): ReorderDatagridColumn` ## Arguments **`input`**: `ReorderDatagridInput!` (required) ## Returns `ReorderDatagridColumn` **`datagridColumn`**: `DatagridColumn` ## Examples ```graphql Mutation mutation ReorderDatagridColumn($input: ReorderDatagridInput!) { reorderDatagridColumn(input: $input) { datagridColumn { LastSessionId Settable _ValuesCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "index": 1 } } ``` ```json Response { "data": { "reorderDatagridColumn": { "datagridColumn": { "LastSessionId": "string", "Settable": true, "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # reorderDatagridRow Source: https://docs.firstresonance.io/api-reference/mutations/reorderDatagridRow Changes the order of rows in a datagrid. **mutation** `reorderDatagridRow(input: ReorderDatagridInput!): ReorderDatagridRow` ## Arguments **`input`**: `ReorderDatagridInput!` (required) ## Returns `ReorderDatagridRow` **`datagridRow`**: `DatagridRow` ## Examples ```graphql Mutation mutation ReorderDatagridRow($input: ReorderDatagridInput!) { reorderDatagridRow(input: $input) { datagridRow { LastSessionId _ValuesCount _created _etag _updated allBatchedSiblings { __typename } } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "index": 1 } } ``` ```json Response { "data": { "reorderDatagridRow": { "datagridRow": { "LastSessionId": "string", "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "DatagridRow" } ] } } } } ``` # reorderIntentOptions Source: https://docs.firstresonance.io/api-reference/mutations/reorderIntentOptions Changes the order of intent options. **mutation** `reorderIntentOptions(input: ReorderIntentOptionsInput!): ReorderIntentOptions` ## Arguments **`input`**: `ReorderIntentOptionsInput!` (required) ## Returns `ReorderIntentOptions` **`intentOptions`**: `[IntentOption]` ## Examples ```graphql Mutation mutation ReorderIntentOptions($input: ReorderIntentOptionsInput!) { reorderIntentOptions(input: $input) { intentOptions { LastSessionId _IssueDispositionTypesCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "intentOptions": [ { "etag": "string", "id": "id" } ] } } ``` ```json Response { "data": { "reorderIntentOptions": { "intentOptions": [ { "LastSessionId": "string", "_IssueDispositionTypesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } ] } } } ``` # reorderLocationPickOrder Source: https://docs.firstresonance.io/api-reference/mutations/reorderLocationPickOrder Orders one level of the pick walk and renumbers the tree to match. **mutation** `reorderLocationPickOrder(input: ReorderLocationPickOrderInput!): ReorderLocationPickOrder` ## Arguments **`input`**: `ReorderLocationPickOrderInput!` (required) ## Returns `ReorderLocationPickOrder` **`locations`**: `[Location]` ## Examples ```graphql Mutation mutation ReorderLocationPickOrder($input: ReorderLocationPickOrderInput!) { reorderLocationPickOrder(input: $input) { locations { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AllChildrenCount _AllParentsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "orderedLocationIds": [ "id" ] } } ``` ```json Response { "data": { "reorderLocationPickOrder": { "locations": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # reorderPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/reorderPurchaseOrderLine Changes the order of line items on a purchase order. **mutation** `reorderPurchaseOrderLine(input: ReorderPurchaseOrderLineInput!): ReorderPurchaseOrderLine` ## Arguments **`input`**: `ReorderPurchaseOrderLineInput!` (required) ## Returns `ReorderPurchaseOrderLine` **`purchaseOrderLine`**: `PurchaseOrderLine` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` ## Examples ```graphql Mutation mutation ReorderPurchaseOrderLine($input: ReorderPurchaseOrderLineInput!) { reorderPurchaseOrderLine(input: $input) { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } reorderedPurchaseOrderLines { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "position": 1 } } ``` ```json Response { "data": { "reorderPurchaseOrderLine": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 }, "reorderedPurchaseOrderLines": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } ] } } } ``` # reorderRunStepFields Source: https://docs.firstresonance.io/api-reference/mutations/reorderRunStepFields Changes the order of fields within a run step. **mutation** `reorderRunStepFields(input: ReorderRunStepFieldsInput!): ReorderRunStepFields` ## Arguments **`input`**: `ReorderRunStepFieldsInput!` (required) ## Returns `ReorderRunStepFields` **`fields`**: `[RunStepField]` ## Examples ```graphql Mutation mutation ReorderRunStepFields($input: ReorderRunStepFieldsInput!) { reorderRunStepFields(input: $input) { fields { LastSessionId _AssigneesCount _IonValueCount _ValidationsCount _ValueCount _created } } } ``` ```json Variables { "input": { "fields": [ { "etag": "string", "id": 1, "position": 1 } ], "runStepId": "id" } } ``` ```json Response { "data": { "reorderRunStepFields": { "fields": [ { "LastSessionId": "string", "_AssigneesCount": 1, "_IonValueCount": 1, "_ValidationsCount": 1, "_ValueCount": 1, "_created": "value" } ] } } } ``` # reorderRunSteps Source: https://docs.firstresonance.io/api-reference/mutations/reorderRunSteps Changes the order of steps within a run. **mutation** `reorderRunSteps(input: ReorderRunStepsInput!): ReorderRunSteps` ## Arguments **`input`**: `ReorderRunStepsInput!` (required) ## Returns `ReorderRunSteps` **`steps`**: `[RunStep]` ## Examples ```graphql Mutation mutation ReorderRunSteps($input: ReorderRunStepsInput!) { reorderRunSteps(input: $input) { steps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "steps": [ { "etag": "string", "id": 1, "position": 1 } ] } } ``` ```json Response { "data": { "reorderRunSteps": { "steps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } ] } } } ``` # reorderStepFields Source: https://docs.firstresonance.io/api-reference/mutations/reorderStepFields Changes the order of fields within a step. **mutation** `reorderStepFields(input: ReorderStepFieldsInput!): ReorderStepFields` ## Arguments **`input`**: `ReorderStepFieldsInput!` (required) ## Returns `ReorderStepFields` **`fields`**: `[StepField]` ## Examples ```graphql Mutation mutation ReorderStepFields($input: ReorderStepFieldsInput!) { reorderStepFields(input: $input) { fields { LastSessionId _ValidationsCount _created _etag _updated allowNotApplicable } } } ``` ```json Variables { "input": { "fields": [ { "etag": "string", "id": 1, "position": 1 } ], "stepId": "id" } } ``` ```json Response { "data": { "reorderStepFields": { "fields": [ { "LastSessionId": "string", "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allowNotApplicable": true } ] } } } ``` # reorderSteps Source: https://docs.firstresonance.io/api-reference/mutations/reorderSteps Changes the order of steps within a procedure. **mutation** `reorderSteps(input: ReorderStepsInput!): ReorderSteps` ## Arguments **`input`**: `ReorderStepsInput!` (required) ## Returns `ReorderSteps` **`steps`**: `[Step]` ## Examples ```graphql Mutation mutation ReorderSteps($input: ReorderStepsInput!) { reorderSteps(input: $input) { steps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "steps": [ { "etag": "string", "id": 1, "position": 1 } ] } } ``` ```json Response { "data": { "reorderSteps": { "steps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } ] } } } ``` # replanPickRun Source: https://docs.firstresonance.io/api-reference/mutations/replanPickRun Rebuilds the unwalked part of a pick-run after stock moved; picked stops are left untouched. **mutation** `replanPickRun(input: ReplanPickRunInput!): ReplanPickRun` ## Arguments **`input`**: `ReplanPickRunInput!` (required) ## Returns `ReplanPickRun` **`pickRun`**: `PickRun` ## Examples ```graphql Mutation mutation ReplanPickRun($input: ReplanPickRunInput!) { replanPickRun(input: $input) { pickRun { Created Etag LastSessionId Updated _KitsCount _StopsCount } } } ``` ```json Variables { "input": { "etag": "string", "pickRunId": "id" } } ``` ```json Response { "data": { "replanPickRun": { "pickRun": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_KitsCount": 1, "_StopsCount": 1 } } } } ``` # resendInvite Source: https://docs.firstresonance.io/api-reference/mutations/resendInvite Resends an invitation to a user to join the organization. **mutation** `resendInvite(etag: String!, id: ID!): ResendInvite` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `ResendInvite` **`invite`**: `Invite` ## Examples ```graphql Mutation mutation ResendInvite($etag: String!, $id: ID!) { resendInvite(etag: $etag, id: $id) { invite { LastSessionId _created _etag _updated auth0InvitationId auth0OrgId } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "resendInvite": { "invite": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0InvitationId": "string", "auth0OrgId": "string" } } } } ``` # resetChangeOrderApprovals Source: https://docs.firstresonance.io/api-reference/mutations/resetChangeOrderApprovals Resets every approval request on an under-review change order to pending, restarting the review round in place. **mutation** `resetChangeOrderApprovals(input: ChangeOrderStatusTransitionInput!): ResetChangeOrderApprovals` ## Arguments **`input`**: `ChangeOrderStatusTransitionInput!` (required) ## Returns `ResetChangeOrderApprovals` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation ResetChangeOrderApprovals($input: ChangeOrderStatusTransitionInput!) { resetChangeOrderApprovals(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "resetChangeOrderApprovals": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # resetFurtherActionApprovals Source: https://docs.firstresonance.io/api-reference/mutations/resetFurtherActionApprovals Resets the approvals for a further action. **mutation** `resetFurtherActionApprovals(input: ResetFurtherActionApprovalsInput!): ResetFurtherActionApprovals` ## Arguments **`input`**: `ResetFurtherActionApprovalsInput!` (required) ## Returns `ResetFurtherActionApprovals` **`furtherActionId`**: `Int` ## Examples ```graphql Mutation mutation ResetFurtherActionApprovals($input: ResetFurtherActionApprovalsInput!) { resetFurtherActionApprovals(input: $input) { furtherActionId } } ``` ```json Variables { "input": { "etag": "string", "furtherActionId": 1 } } ``` ```json Response { "data": { "resetFurtherActionApprovals": { "furtherActionId": 1 } } } ``` # resetIssueApprovals Source: https://docs.firstresonance.io/api-reference/mutations/resetIssueApprovals Resets the approvals for an issue. **mutation** `resetIssueApprovals(input: ResetIssueApprovalsInput!): ResetIssueApprovals` ## Arguments **`input`**: `ResetIssueApprovalsInput!` (required) ## Returns `ResetIssueApprovals` **`issueId`**: `Int` ## Examples ```graphql Mutation mutation ResetIssueApprovals($input: ResetIssueApprovalsInput!) { resetIssueApprovals(input: $input) { issueId } } ``` ```json Variables { "input": { "etag": "string", "issueId": 1 } } ``` ```json Response { "data": { "resetIssueApprovals": { "issueId": 1 } } } ``` # resetPurchaseOrderApprovalLevels Source: https://docs.firstresonance.io/api-reference/mutations/resetPurchaseOrderApprovalLevels Resets the approval levels for a purchase order. **mutation** `resetPurchaseOrderApprovalLevels(etag: String!, id: ID!): ResetPurchaseOrderApprovalLevels` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `ResetPurchaseOrderApprovalLevels` **`id`**: `Int` ## Examples ```graphql Mutation mutation ResetPurchaseOrderApprovalLevels($etag: String!, $id: ID!) { resetPurchaseOrderApprovalLevels(etag: $etag, id: $id) { id } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "resetPurchaseOrderApprovalLevels": { "id": 1 } } } ``` # resetRedlineApprovals Source: https://docs.firstresonance.io/api-reference/mutations/resetRedlineApprovals Resets all approvals on an open redline so it can be edited and resubmitted for review. **mutation** `resetRedlineApprovals(input: ResetRedlineApprovalsInput!): ResetRedlineApprovals` ## Arguments **`input`**: `ResetRedlineApprovalsInput!` (required) ## Returns `ResetRedlineApprovals` **`redlineId`**: `Int` ## Examples ```graphql Mutation mutation ResetRedlineApprovals($input: ResetRedlineApprovalsInput!) { resetRedlineApprovals(input: $input) { redlineId } } ``` ```json Variables { "input": { "etag": "string", "redlineId": 1 } } ``` ```json Response { "data": { "resetRedlineApprovals": { "redlineId": 1 } } } ``` # resolvePartInventoryReview Source: https://docs.firstresonance.io/api-reference/mutations/resolvePartInventoryReview Resolves a part inventory record awaiting human review. **mutation** `resolvePartInventoryReview(input: ResolvePartInventoryReviewInput!): ResolvePartInventoryReview` ## Arguments **`input`**: `ResolvePartInventoryReviewInput!` (required) ## Returns `ResolvePartInventoryReview` **`deletedId`**: `Int` --- **`partInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation ResolvePartInventoryReview($input: ResolvePartInventoryReviewInput!) { resolvePartInventoryReview(input: $input) { deletedId partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "resolution": "DELETE" } } ``` ```json Response { "data": { "resolvePartInventoryReview": { "deletedId": 1, "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # returnChangeOrderToDraft Source: https://docs.firstresonance.io/api-reference/mutations/returnChangeOrderToDraft Returns a change order to draft, resetting the approval gate. In-flight workflow changes survive the reset. **mutation** `returnChangeOrderToDraft(input: ChangeOrderStatusTransitionInput!): ReturnChangeOrderToDraft` ## Arguments **`input`**: `ChangeOrderStatusTransitionInput!` (required) ## Returns `ReturnChangeOrderToDraft` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation ReturnChangeOrderToDraft($input: ChangeOrderStatusTransitionInput!) { returnChangeOrderToDraft(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "returnChangeOrderToDraft": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # revokeInvite Source: https://docs.firstresonance.io/api-reference/mutations/revokeInvite Revokes an invitation that has been sent to a user. **mutation** `revokeInvite(etag: String!, id: ID!): RevokeInvite` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `RevokeInvite` **`invite`**: `Invite` ## Examples ```graphql Mutation mutation RevokeInvite($etag: String!, $id: ID!) { revokeInvite(etag: $etag, id: $id) { invite { LastSessionId _created _etag _updated auth0InvitationId auth0OrgId } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "revokeInvite": { "invite": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0InvitationId": "string", "auth0OrgId": "string" } } } } ``` # rotateSsoSigningCredentials Source: https://docs.firstresonance.io/api-reference/mutations/rotateSsoSigningCredentials Replace IdP signing material (PEM cert or SAML metadata XML) on the org's enterprise SSO connection. **mutation** `rotateSsoSigningCredentials(signingCredentials: String!): RotateSSOSigningCredentials` ## Arguments **`signingCredentials`**: `String!` (required) ## Returns `RotateSSOSigningCredentials` **`rotation`**: `SSOSigningRotation` ## Examples ```graphql Mutation mutation RotateSsoSigningCredentials($signingCredentials: String!) { rotateSsoSigningCredentials(signingCredentials: $signingCredentials) { rotation { certFingerprint connectionName } } } ``` ```json Variables { "signingCredentials": "string" } ``` ```json Response { "data": { "rotateSsoSigningCredentials": { "rotation": { "certFingerprint": "string", "connectionName": "string" } } } } ``` # saveReceipt Source: https://docs.firstresonance.io/api-reference/mutations/saveReceipt Saves a receipt after adding or removing items. **mutation** `saveReceipt(input: SaveReceiptInput): SaveReceipt` ## Arguments **`input`**: `SaveReceiptInput` ## Returns `SaveReceipt` **`consumedPartInventoryIds`**: `[Int]` --- **`mergedPartInventories`**: `[PartInventory]` --- **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation SaveReceipt { saveReceipt { consumedPartInventoryIds mergedPartInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "saveReceipt": { "consumedPartInventoryIds": [ 1 ], "mergedPartInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ], "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # setDatagridValue Source: https://docs.firstresonance.io/api-reference/mutations/setDatagridValue Sets the value of a cell in a datagrid. **mutation** `setDatagridValue(input: SetDatagridValueInput!): SetDatagridValue` ## Arguments **`input`**: `SetDatagridValueInput!` (required) ## Returns `SetDatagridValue` **`datagridValue`**: `DatagridValue` ## Examples ```graphql Mutation mutation SetDatagridValue($input: SetDatagridValueInput!) { setDatagridValue(input: $input) { datagridValue { BooleanValue DatetimeValue LastSessionId MultiselectValues NumberValue SelectValue } } } ``` ```json Variables { "input": { "columnId": 1, "rowId": 1 } } ``` ```json Response { "data": { "setDatagridValue": { "datagridValue": { "BooleanValue": true, "DatetimeValue": "value", "LastSessionId": "string", "MultiselectValues": [ "string" ], "NumberValue": 1.5, "SelectValue": "string" } } } } ``` # splitManyPartInventory Source: https://docs.firstresonance.io/api-reference/mutations/splitManyPartInventory Splits a part inventory record into multiple new records. **mutation** `splitManyPartInventory(input: SplitManyPartInventoryInput): SplitManyPartInventory` ## Arguments **`input`**: `SplitManyPartInventoryInput` ## Returns `SplitManyPartInventory` **`partInventories`**: `[PartInventory]` ## Examples ```graphql Mutation mutation SplitManyPartInventory { splitManyPartInventory { partInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "splitManyPartInventory": { "partInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # splitPartInventory Source: https://docs.firstresonance.io/api-reference/mutations/splitPartInventory Splits a single part inventory record into two. **mutation** `splitPartInventory(input: SplitPartInventoryInput): SplitPartInventory` ## Arguments **`input`**: `SplitPartInventoryInput` ## Returns `SplitPartInventory` **`partInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation SplitPartInventory { splitPartInventory { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "splitPartInventory": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # splitUnfulfilledPartKit Source: https://docs.firstresonance.io/api-reference/mutations/splitUnfulfilledPartKit Splits a part kit that has not been completely fulfilled into two kits. **mutation** `splitUnfulfilledPartKit(input: SplitUnfulfilledPartKitInput!): SplitUnfulfilledPartKit` ## Arguments **`input`**: `SplitUnfulfilledPartKitInput!` (required) ## Returns `SplitUnfulfilledPartKit` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation SplitUnfulfilledPartKit($input: SplitUnfulfilledPartKitInput!) { splitUnfulfilledPartKit(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": { "etag": "string", "partKitId": "id" } } ``` ```json Response { "data": { "splitUnfulfilledPartKit": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # submitChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/submitChangeOrder Submits a draft change order for review. Requires targets, reviewers, and every resolution confirmed. **mutation** `submitChangeOrder(input: ChangeOrderStatusTransitionInput!): SubmitChangeOrder` ## Arguments **`input`**: `ChangeOrderStatusTransitionInput!` (required) ## Returns `SubmitChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation SubmitChangeOrder($input: ChangeOrderStatusTransitionInput!) { submitChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "submitChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # submitRunAbomJustification Source: https://docs.firstresonance.io/api-reference/mutations/submitRunAbomJustification Formally submits the ABOM completion justification on a run. **mutation** `submitRunAbomJustification(input: SubmitRunAbomJustificationInput!): SubmitRunAbomJustification` ## Arguments **`input`**: `SubmitRunAbomJustificationInput!` (required) ## Returns `SubmitRunAbomJustification` **`run`**: `Run` ## Examples ```graphql Mutation mutation SubmitRunAbomJustification($input: SubmitRunAbomJustificationInput!) { submitRunAbomJustification(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "runId": 1 } } ``` ```json Response { "data": { "submitRunAbomJustification": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # unassignReferenceDesignatorFromRunStep Source: https://docs.firstresonance.io/api-reference/mutations/unassignReferenceDesignatorFromRunStep Unassigns a reference designator from a run step; a manual designator is removed outright, an mBOM-origin one is tombstoned so reconcile cannot revive it. **mutation** `unassignReferenceDesignatorFromRunStep(input: UnassignReferenceDesignatorFromRunStepInput!): UnassignReferenceDesignatorFromRunStep` ## Arguments **`input`**: `UnassignReferenceDesignatorFromRunStepInput!` (required) ## Returns `UnassignReferenceDesignatorFromRunStep` **`buildRequirementReferenceDesignatorId`**: `Int` ## Examples ```graphql Mutation mutation UnassignReferenceDesignatorFromRunStep($input: UnassignReferenceDesignatorFromRunStepInput!) { unassignReferenceDesignatorFromRunStep(input: $input) { buildRequirementReferenceDesignatorId } } ``` ```json Variables { "input": { "buildRequirementReferenceDesignatorId": 1, "etag": "string", "runStepId": 1 } } ``` ```json Response { "data": { "unassignReferenceDesignatorFromRunStep": { "buildRequirementReferenceDesignatorId": 1 } } } ``` # unbatchRunSteps Source: https://docs.firstresonance.io/api-reference/mutations/unbatchRunSteps Removes run steps from a batch. **mutation** `unbatchRunSteps(input: [UnbatchRunStepsInput]): UnbatchRunSteps` ## Arguments **`input`**: `[UnbatchRunStepsInput]` ## Returns `UnbatchRunSteps` **`runSteps`**: `[RunStep]` ## Examples ```graphql Mutation mutation UnbatchRunSteps { unbatchRunSteps { runSteps { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Response { "data": { "unbatchRunSteps": { "runSteps": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } ] } } } ``` # unconfirmMbomChangeOrderLineDiffResolution Source: https://docs.firstresonance.io/api-reference/mutations/unconfirmMbomChangeOrderLineDiffResolution Takes the sign-off back off mBOM change diff resolutions, optionally on every line sharing them. Each row keeps the resolution it shows. **mutation** `unconfirmMbomChangeOrderLineDiffResolution(input: UnconfirmMbomChangeOrderLineDiffResolutionInput!): UnconfirmMbomChangeOrderLineDiffResolution` ## Arguments **`input`**: `UnconfirmMbomChangeOrderLineDiffResolutionInput!` (required) ## Returns `UnconfirmMbomChangeOrderLineDiffResolution` **`diffs`**: `[MbomChangeOrderLineDiff]` ## Examples ```graphql Mutation mutation UnconfirmMbomChangeOrderLineDiffResolution($input: UnconfirmMbomChangeOrderLineDiffResolutionInput!) { unconfirmMbomChangeOrderLineDiffResolution(input: $input) { diffs { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "sources": [ { "etag": "string", "id": 1 } ] } } ``` ```json Response { "data": { "unconfirmMbomChangeOrderLineDiffResolution": { "diffs": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } ] } } } ``` # undoStepProposal Source: https://docs.firstresonance.io/api-reference/mutations/undoStepProposal Restores the content an accepted revision replaced and returns the proposal to pending. Refuses if the step changed after the accept. **mutation** `undoStepProposal(etag: String!, id: ID!): UndoStepProposal` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `UndoStepProposal` **`step`**: `Step` --- **`stepProposal`**: `StepProposal` ## Examples ```graphql Mutation mutation UndoStepProposal($etag: String!, $id: ID!) { undoStepProposal(etag: $etag, id: $id) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } stepProposal { LastSessionId _created _etag _updated acceptedEtag applicationPreview { applicable conflictMessage content slateContent title } } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "undoStepProposal": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 }, "stepProposal": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "applicable": true, "conflictMessage": "string", "content": "string", "slateContent": "value", "title": "string" } } } } } ``` # unlinkRunStepFromPurchaseOrder Source: https://docs.firstresonance.io/api-reference/mutations/unlinkRunStepFromPurchaseOrder Unlinks an OSP run step from its purchase order line without deleting the PO line. **mutation** `unlinkRunStepFromPurchaseOrder(input: UnlinkRunStepFromPurchaseOrderInput!): UnlinkRunStepFromPurchaseOrder` ## Arguments **`input`**: `UnlinkRunStepFromPurchaseOrderInput!` (required) ## Returns `UnlinkRunStepFromPurchaseOrder` **`purchaseOrderLine`**: `PurchaseOrderLine` ## Examples ```graphql Mutation mutation UnlinkRunStepFromPurchaseOrder($input: UnlinkRunStepFromPurchaseOrderInput!) { unlinkRunStepFromPurchaseOrder(input: $input) { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "runStepId": 1 } } ``` ```json Response { "data": { "unlinkRunStepFromPurchaseOrder": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # updateAbomInstallation Source: https://docs.firstresonance.io/api-reference/mutations/updateAbomInstallation Updates a component installation on an as-built bill of materials (aBOM). **mutation** `updateAbomInstallation(input: UpdateABomInstallationInput): UpdateABomInstallation` ## Arguments **`input`**: `UpdateABomInstallationInput` ## Returns `UpdateABomInstallation` **`abomInstallation`**: `ABomInstallation` --- **`splitInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation UpdateAbomInstallation { updateAbomInstallation { abomInstallation { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } splitInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "updateAbomInstallation": { "abomInstallation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 }, "splitInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateApiKey Source: https://docs.firstresonance.io/api-reference/mutations/updateApiKey Updates an existing API key. This can be used to change the key's name or other properties. **mutation** `updateApiKey(input: APIKeyInput!): UpdateAPIKey` ## Arguments **`input`**: `APIKeyInput!` (required) ## Returns `UpdateAPIKey` **`apikey`**: `APIKeyObject` ## Examples ```graphql Mutation mutation UpdateApiKey($input: APIKeyInput!) { updateApiKey(input: $input) { apikey { _created _etag _updated clientId clientSecret createdByApiClient { id name } } } } ``` ```json Variables { "input": { "_etag": "string", "clientId": "string" } } ``` ```json Response { "data": { "updateApiKey": { "apikey": { "_created": "value", "_etag": "string", "_updated": "value", "clientId": "string", "clientSecret": "string", "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/updateApprovalLevel **mutation** `updateApprovalLevel(input: UpdateApprovalLevelInput!): UpdateApprovalLevel` ## Arguments **`input`**: `UpdateApprovalLevelInput!` (required) ## Returns `UpdateApprovalLevel` **`approvalLevel`**: `ApprovalLevel` ## Examples ```graphql Mutation mutation UpdateApprovalLevel($input: UpdateApprovalLevelInput!) { updateApprovalLevel(input: $input) { approvalLevel { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateApprovalLevel": { "approvalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateBarcodeLabel Source: https://docs.firstresonance.io/api-reference/mutations/updateBarcodeLabel **mutation** `updateBarcodeLabel(input: UpdateBarcodeLabelInput!): UpdateBarcodeLabel` ## Arguments **`input`**: `UpdateBarcodeLabelInput!` (required) ## Returns `UpdateBarcodeLabel` **`barcodeLabel`**: `BarcodeLabel` ## Examples ```graphql Mutation mutation UpdateBarcodeLabel($input: UpdateBarcodeLabelInput!) { updateBarcodeLabel(input: $input) { barcodeLabel { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateBarcodeLabel": { "barcodeLabel": { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } } } } ``` # updateBarcodePattern Source: https://docs.firstresonance.io/api-reference/mutations/updateBarcodePattern **mutation** `updateBarcodePattern(input: UpdateBarcodePatternInput!): UpdateBarcodePattern` ## Arguments **`input`**: `UpdateBarcodePatternInput!` (required) ## Returns `UpdateBarcodePattern` **`barcodePattern`**: `BarcodePattern` ## Examples ```graphql Mutation mutation UpdateBarcodePattern($input: UpdateBarcodePatternInput!) { updateBarcodePattern(input: $input) { barcodePattern { LastSessionId _created _etag _updated barcodePatternJson createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateBarcodePattern": { "barcodePattern": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodePatternJson": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateBarcodeTemplate Source: https://docs.firstresonance.io/api-reference/mutations/updateBarcodeTemplate **mutation** `updateBarcodeTemplate(input: UpdateBarcodeTemplateInput!): UpdateBarcodeTemplate` ## Arguments **`input`**: `UpdateBarcodeTemplateInput!` (required) ## Returns `UpdateBarcodeTemplate` **`barcodeTemplate`**: `BarcodeTemplate` ## Examples ```graphql Mutation mutation UpdateBarcodeTemplate($input: UpdateBarcodeTemplateInput!) { updateBarcodeTemplate(input: $input) { barcodeTemplate { LastSessionId _BarcodeLabelsCount _created _etag _updated barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateBarcodeTemplate": { "barcodeTemplate": { "LastSessionId": "string", "_BarcodeLabelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ] } } } } ``` # updateBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/updateBuildRequirement **mutation** `updateBuildRequirement(input: UpdateBuildRequirementInput!): UpdateBuildRequirement` ## Arguments **`input`**: `UpdateBuildRequirementInput!` (required) ## Returns `UpdateBuildRequirement` **`buildRequirement`**: `BuildRequirement` ## Examples ```graphql Mutation mutation UpdateBuildRequirement($input: UpdateBuildRequirementInput!) { updateBuildRequirement(input: $input) { buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateBuildRequirement": { "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 } } } } ``` # updateBuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/mutations/updateBuildRequirementReferenceDesignator **mutation** `updateBuildRequirementReferenceDesignator(input: UpdateBuildRequirementReferenceDesignatorInput!): UpdateBuildRequirementReferenceDesignator` ## Arguments **`input`**: `UpdateBuildRequirementReferenceDesignatorInput!` (required) ## Returns `UpdateBuildRequirementReferenceDesignator` **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignator` ## Examples ```graphql Mutation mutation UpdateBuildRequirementReferenceDesignator($input: UpdateBuildRequirementReferenceDesignatorInput!) { updateBuildRequirementReferenceDesignator(input: $input) { buildRequirementReferenceDesignator { LastSessionId _AbomInstallationsCount _InstalledPartInventoriesCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "value": "string" } } ``` ```json Response { "data": { "updateBuildRequirementReferenceDesignator": { "buildRequirementReferenceDesignator": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_InstalledPartInventoriesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/mutations/updateBuildRequirementSubstitute **mutation** `updateBuildRequirementSubstitute(input: UpdateBuildRequirementSubstituteInput!): UpdateBuildRequirementSubstitute` ## Arguments **`input`**: `UpdateBuildRequirementSubstituteInput!` (required) ## Returns `UpdateBuildRequirementSubstitute` **`buildRequirementSubstitute`**: `BuildRequirementSubstitute` ## Examples ```graphql Mutation mutation UpdateBuildRequirementSubstitute($input: UpdateBuildRequirementSubstituteInput!) { updateBuildRequirementSubstitute(input: $input) { buildRequirementSubstitute { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "partId": 1 } } ``` ```json Response { "data": { "updateBuildRequirementSubstitute": { "buildRequirementSubstitute": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } } ``` # updateChangeOrder Source: https://docs.firstresonance.io/api-reference/mutations/updateChangeOrder **mutation** `updateChangeOrder(input: UpdateChangeOrderInput!): UpdateChangeOrder` ## Arguments **`input`**: `UpdateChangeOrderInput!` (required) ## Returns `UpdateChangeOrder` **`changeOrder`**: `ChangeOrder` ## Examples ```graphql Mutation mutation UpdateChangeOrder($input: UpdateChangeOrderInput!) { updateChangeOrder(input: $input) { changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateChangeOrder": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # updateChangeOrderApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateChangeOrderApproval **mutation** `updateChangeOrderApproval(input: UpdateChangeOrderApprovalInput!): UpdateChangeOrderApproval` ## Arguments **`input`**: `UpdateChangeOrderApprovalInput!` (required) ## Returns `UpdateChangeOrderApproval` **`approval`**: `ChangeOrderApproval` ## Examples ```graphql Mutation mutation UpdateChangeOrderApproval($input: UpdateChangeOrderApprovalInput!) { updateChangeOrderApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateChangeOrderApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } } ``` # updateChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateChangeOrderApprovalRequest **mutation** `updateChangeOrderApprovalRequest(input: UpdateChangeOrderApprovalRequestInput!): UpdateChangeOrderApprovalRequest` ## Arguments **`input`**: `UpdateChangeOrderApprovalRequestInput!` (required) ## Returns `UpdateChangeOrderApprovalRequest` **`approvalRequest`**: `ChangeOrderApprovalRequest` ## Examples ```graphql Mutation mutation UpdateChangeOrderApprovalRequest($input: UpdateChangeOrderApprovalRequestInput!) { updateChangeOrderApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateChangeOrderApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/updateChangeOrderApprovalRole **mutation** `updateChangeOrderApprovalRole(input: UpdateChangeOrderApprovalRoleInput!): UpdateChangeOrderApprovalRole` ## Arguments **`input`**: `UpdateChangeOrderApprovalRoleInput!` (required) ## Returns `UpdateChangeOrderApprovalRole` **`approvalRole`**: `ChangeOrderApprovalRole` ## Examples ```graphql Mutation mutation UpdateChangeOrderApprovalRole($input: UpdateChangeOrderApprovalRoleInput!) { updateChangeOrderApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "gateType": "APPROVED", "roleId": 1 } } ``` ```json Response { "data": { "updateChangeOrderApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateChargeAccount Source: https://docs.firstresonance.io/api-reference/mutations/updateChargeAccount **mutation** `updateChargeAccount(input: UpdateChargeAccountInput!): UpdateChargeAccount` ## Arguments **`input`**: `UpdateChargeAccountInput!` (required) ## Returns `UpdateChargeAccount` **`chargeAccount`**: `ChargeAccount` ## Examples ```graphql Mutation mutation UpdateChargeAccount($input: UpdateChargeAccountInput!) { updateChargeAccount(input: $input) { chargeAccount { LastSessionId _created _etag _updated archived code } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateChargeAccount": { "chargeAccount": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } } } ``` # updateComment Source: https://docs.firstresonance.io/api-reference/mutations/updateComment **mutation** `updateComment(input: UpdateCommentInput!): UpdateComment` ## Arguments **`input`**: `UpdateCommentInput!` (required) ## Returns `UpdateComment` **`comment`**: `Comment` ## Examples ```graphql Mutation mutation UpdateComment($input: UpdateCommentInput!) { updateComment(input: $input) { comment { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateComment": { "comment": { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } } } } ``` # updateContact Source: https://docs.firstresonance.io/api-reference/mutations/updateContact **mutation** `updateContact(input: UpdateContactInput!): UpdateContact` ## Arguments **`input`**: `UpdateContactInput!` (required) ## Returns `UpdateContact` **`contact`**: `Contact` ## Examples ```graphql Mutation mutation UpdateContact($input: UpdateContactInput!) { updateContact(input: $input) { contact { LastSessionId _LocationsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateContact": { "contact": { "LastSessionId": "string", "_LocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateCurrency Source: https://docs.firstresonance.io/api-reference/mutations/updateCurrency **mutation** `updateCurrency(input: UpdateCurrencyInput!): UpdateCurrency` ## Arguments **`input`**: `UpdateCurrencyInput!` (required) ## Returns `UpdateCurrency` **`currency`**: `Currency` ## Examples ```graphql Mutation mutation UpdateCurrency($input: UpdateCurrencyInput!) { updateCurrency(input: $input) { currency { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateCurrency": { "currency": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateDatagridColumn Source: https://docs.firstresonance.io/api-reference/mutations/updateDatagridColumn **mutation** `updateDatagridColumn(input: UpdateDatagridColumnInput!): UpdateDatagridColumn` ## Arguments **`input`**: `UpdateDatagridColumnInput!` (required) ## Returns `UpdateDatagridColumn` **`datagridColumn`**: `DatagridColumn` ## Examples ```graphql Mutation mutation UpdateDatagridColumn($input: UpdateDatagridColumnInput!) { updateDatagridColumn(input: $input) { datagridColumn { LastSessionId Settable _ValuesCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateDatagridColumn": { "datagridColumn": { "LastSessionId": "string", "Settable": true, "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateDatagridRow Source: https://docs.firstresonance.io/api-reference/mutations/updateDatagridRow **mutation** `updateDatagridRow(input: UpdateDatagridRowInput!): UpdateDatagridRow` ## Arguments **`input`**: `UpdateDatagridRowInput!` (required) ## Returns `UpdateDatagridRow` **`datagridRow`**: `DatagridRow` ## Examples ```graphql Mutation mutation UpdateDatagridRow($input: UpdateDatagridRowInput!) { updateDatagridRow(input: $input) { datagridRow { LastSessionId _ValuesCount _created _etag _updated allBatchedSiblings { __typename } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateDatagridRow": { "datagridRow": { "LastSessionId": "string", "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "DatagridRow" } ] } } } } ``` # updateFurtherAction Source: https://docs.firstresonance.io/api-reference/mutations/updateFurtherAction **mutation** `updateFurtherAction(input: UpdateFurtherActionInput!): UpdateFurtherAction` ## Arguments **`input`**: `UpdateFurtherActionInput!` (required) ## Returns `UpdateFurtherAction` **`furtherAction`**: `FurtherAction` ## Examples ```graphql Mutation mutation UpdateFurtherAction($input: UpdateFurtherActionInput!) { updateFurtherAction(input: $input) { furtherAction { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateFurtherAction": { "furtherAction": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } } } ``` # updateFurtherActionApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateFurtherActionApproval **mutation** `updateFurtherActionApproval(input: UpdateFurtherActionApprovalInput!): UpdateFurtherActionApproval` ## Arguments **`input`**: `UpdateFurtherActionApprovalInput!` (required) ## Returns `UpdateFurtherActionApproval` **`approval`**: `FurtherActionApproval` ## Examples ```graphql Mutation mutation UpdateFurtherActionApproval($input: UpdateFurtherActionApprovalInput!) { updateFurtherActionApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateFurtherActionApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateFurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateFurtherActionApprovalRequest **mutation** `updateFurtherActionApprovalRequest(input: UpdateFurtherActionApprovalRequestInput!): UpdateFurtherActionApprovalRequest` ## Arguments **`input`**: `UpdateFurtherActionApprovalRequestInput!` (required) ## Returns `UpdateFurtherActionApprovalRequest` **`approvalRequest`**: `FurtherActionApprovalRequest` ## Examples ```graphql Mutation mutation UpdateFurtherActionApprovalRequest($input: UpdateFurtherActionApprovalRequestInput!) { updateFurtherActionApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateFurtherActionApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateFurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/updateFurtherActionApprovalRole **mutation** `updateFurtherActionApprovalRole(input: UpdateFurtherActionApprovalRoleInput!): UpdateFurtherActionApprovalRole` ## Arguments **`input`**: `UpdateFurtherActionApprovalRoleInput!` (required) ## Returns `UpdateFurtherActionApprovalRole` **`approvalRole`**: `FurtherActionApprovalRole` ## Examples ```graphql Mutation mutation UpdateFurtherActionApprovalRole($input: UpdateFurtherActionApprovalRoleInput!) { updateFurtherActionApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "gateType": "RESOLVED", "roleId": 1 } } ``` ```json Response { "data": { "updateFurtherActionApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateImportJob Source: https://docs.firstresonance.io/api-reference/mutations/updateImportJob **mutation** `updateImportJob(input: UpdateImportJobInput!): UpdateImportJob` ## Arguments **`input`**: `UpdateImportJobInput!` (required) ## Returns `UpdateImportJob` **`importJob`**: `ImportJob` ## Examples ```graphql Mutation mutation UpdateImportJob($input: UpdateImportJobInput!) { updateImportJob(input: $input) { importJob { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateImportJob": { "importJob": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateInputToPlan Source: https://docs.firstresonance.io/api-reference/mutations/updateInputToPlan **mutation** `updateInputToPlan(input: UpdateInputToPlanInput!): UpdateInputToPlan` ## Arguments **`input`**: `UpdateInputToPlanInput!` (required) ## Returns `UpdateInputToPlan` **`planInput`**: `PlanInput` ## Examples ```graphql Mutation mutation UpdateInputToPlan($input: UpdateInputToPlanInput!) { updateInputToPlan(input: $input) { planInput { Deleted LastSessionId _PlanItemsCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateInputToPlan": { "planInput": { "Deleted": true, "LastSessionId": "string", "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateIntentOption Source: https://docs.firstresonance.io/api-reference/mutations/updateIntentOption **mutation** `updateIntentOption(input: UpdateIntentOptionInput!): UpdateIntentOption` ## Arguments **`input`**: `UpdateIntentOptionInput!` (required) ## Returns `UpdateIntentOption` **`intentOption`**: `IntentOption` ## Examples ```graphql Mutation mutation UpdateIntentOption($input: UpdateIntentOptionInput!) { updateIntentOption(input: $input) { intentOption { LastSessionId _IssueDispositionTypesCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateIntentOption": { "intentOption": { "LastSessionId": "string", "_IssueDispositionTypesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateIssue Source: https://docs.firstresonance.io/api-reference/mutations/updateIssue **mutation** `updateIssue(input: UpdateIssueInput!): UpdateIssue` ## Arguments **`input`**: `UpdateIssueInput!` (required) ## Returns `UpdateIssue` **`issue`**: `Issue` ## Examples ```graphql Mutation mutation UpdateIssue($input: UpdateIssueInput!) { updateIssue(input: $input) { issue { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateIssue": { "issue": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } } } ``` # updateIssueApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateIssueApproval **mutation** `updateIssueApproval(input: UpdateIssueApprovalInput!): UpdateIssueApproval` ## Arguments **`input`**: `UpdateIssueApprovalInput!` (required) ## Returns `UpdateIssueApproval` **`approval`**: `IssueApproval` ## Examples ```graphql Mutation mutation UpdateIssueApproval($input: UpdateIssueApprovalInput!) { updateIssueApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateIssueApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateIssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateIssueApprovalRequest **mutation** `updateIssueApprovalRequest(input: UpdateIssueApprovalRequestInput!): UpdateIssueApprovalRequest` ## Arguments **`input`**: `UpdateIssueApprovalRequestInput!` (required) ## Returns `UpdateIssueApprovalRequest` **`approvalRequest`**: `IssueApprovalRequest` ## Examples ```graphql Mutation mutation UpdateIssueApprovalRequest($input: UpdateIssueApprovalRequestInput!) { updateIssueApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateIssueApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateIssueAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateIssueAttribute Updates an attribute on an issue. **mutation** `updateIssueAttribute(input: UpdateIssueAttributeInput!): UpdateIssueAttribute` ## Arguments **`input`**: `UpdateIssueAttributeInput!` (required) ## Returns `UpdateIssueAttribute` **`issueAttribute`**: `IssueAttribute` ## Examples ```graphql Mutation mutation UpdateIssueAttribute($input: UpdateIssueAttributeInput!) { updateIssueAttribute(input: $input) { issueAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "issueId": 1, "key": "string" } } ``` ```json Response { "data": { "updateIssueAttribute": { "issueAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateIssueDispositionType Source: https://docs.firstresonance.io/api-reference/mutations/updateIssueDispositionType **mutation** `updateIssueDispositionType(input: UpdateIssueDispositionTypeInput!): UpdateIssueDispositionType` ## Arguments **`input`**: `UpdateIssueDispositionTypeInput!` (required) ## Returns `UpdateIssueDispositionType` **`issueDispositionType`**: `IssueDispositionType` ## Examples ```graphql Mutation mutation UpdateIssueDispositionType($input: UpdateIssueDispositionTypeInput!) { updateIssueDispositionType(input: $input) { issueDispositionType { LastSessionId _IssueDispositionTypeRolesCount _IssuesCount _RolesCount _created _etag } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateIssueDispositionType": { "issueDispositionType": { "LastSessionId": "string", "_IssueDispositionTypeRolesCount": 1, "_IssuesCount": 1, "_RolesCount": 1, "_created": "value", "_etag": "string" } } } } ``` # updateIssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/mutations/updateIssueDispositionTypeRole **mutation** `updateIssueDispositionTypeRole(input: UpdateIssueDispositionTypeRoleInput!): UpdateIssueDispositionTypeRole` ## Arguments **`input`**: `UpdateIssueDispositionTypeRoleInput!` (required) ## Returns `UpdateIssueDispositionTypeRole` **`issueDispositionTypeRole`**: `IssueDispositionTypeRole` ## Examples ```graphql Mutation mutation UpdateIssueDispositionTypeRole($input: UpdateIssueDispositionTypeRoleInput!) { updateIssueDispositionTypeRole(input: $input) { issueDispositionTypeRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "issueApprovalGateType": "IN_PROGRESS", "issueDispositionTypeId": 1, "roleId": 1 } } ``` ```json Response { "data": { "updateIssueDispositionTypeRole": { "issueDispositionTypeRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateLabel Source: https://docs.firstresonance.io/api-reference/mutations/updateLabel **mutation** `updateLabel(input: UpdateLabelInput!): UpdateLabel` ## Arguments **`input`**: `UpdateLabelInput!` (required) ## Returns `UpdateLabel` **`label`**: `Label` ## Examples ```graphql Mutation mutation UpdateLabel($input: UpdateLabelInput!) { updateLabel(input: $input) { label { LastSessionId _EntitiesCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "value": "string" } } ``` ```json Response { "data": { "updateLabel": { "label": { "LastSessionId": "string", "_EntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateLocation Source: https://docs.firstresonance.io/api-reference/mutations/updateLocation **mutation** `updateLocation(input: UpdateLocationInput!): UpdateLocation` ## Arguments **`input`**: `UpdateLocationInput!` (required) ## Returns `UpdateLocation` **`location`**: `Location` ## Examples ```graphql Mutation mutation UpdateLocation($input: UpdateLocationInput!) { updateLocation(input: $input) { location { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AllChildrenCount _AllParentsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateLocation": { "location": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateLocationAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateLocationAttribute Updates an attribute on a location. **mutation** `updateLocationAttribute(input: UpdateLocationAttributeInput!): UpdateLocationAttribute` ## Arguments **`input`**: `UpdateLocationAttributeInput!` (required) ## Returns `UpdateLocationAttribute` **`locationAttribute`**: `LocationAttribute` ## Examples ```graphql Mutation mutation UpdateLocationAttribute($input: UpdateLocationAttributeInput!) { updateLocationAttribute(input: $input) { locationAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "locationId": 1 } } ``` ```json Response { "data": { "updateLocationAttribute": { "locationAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateLocationSubtype Source: https://docs.firstresonance.io/api-reference/mutations/updateLocationSubtype **mutation** `updateLocationSubtype(input: UpdateLocationSubtypeInput!): UpdateLocationSubtype` ## Arguments **`input`**: `UpdateLocationSubtypeInput!` (required) ## Returns `UpdateLocationSubtype` **`locationSubtype`**: `LocationSubtype` ## Examples ```graphql Mutation mutation UpdateLocationSubtype($input: UpdateLocationSubtypeInput!) { updateLocationSubtype(input: $input) { locationSubtype { LastSessionId _LocationsCount _StepsCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateLocationSubtype": { "locationSubtype": { "LastSessionId": "string", "_LocationsCount": 1, "_StepsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateMbom Source: https://docs.firstresonance.io/api-reference/mutations/updateMbom **mutation** `updateMbom(input: UpdateMBomInput!): UpdateMBom` ## Arguments **`input`**: `UpdateMBomInput!` (required) ## Returns `UpdateMBom` **`mbom`**: `MBom` ## Examples ```graphql Mutation mutation UpdateMbom($input: UpdateMBomInput!) { updateMbom(input: $input) { mbom { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateMbom": { "mbom": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateMbomApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateMbomApproval **mutation** `updateMbomApproval(input: UpdateMBomApprovalInput!): UpdateMBomApproval` ## Arguments **`input`**: `UpdateMBomApprovalInput!` (required) ## Returns `UpdateMBomApproval` **`approval`**: `MBomApproval` ## Examples ```graphql Mutation mutation UpdateMbomApproval($input: UpdateMBomApprovalInput!) { updateMbomApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateMbomApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateMbomApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateMbomApprovalRequest **mutation** `updateMbomApprovalRequest(input: UpdateMBomApprovalRequestInput!): UpdateMBomApprovalRequest` ## Arguments **`input`**: `UpdateMBomApprovalRequestInput!` (required) ## Returns `UpdateMBomApprovalRequest` **`approvalRequest`**: `MBomApprovalRequest` ## Examples ```graphql Mutation mutation UpdateMbomApprovalRequest($input: UpdateMBomApprovalRequestInput!) { updateMbomApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateMbomApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateMbomApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/updateMbomApprovalRole **mutation** `updateMbomApprovalRole(input: UpdateMBomApprovalRoleInput!): UpdateMBomApprovalRole` ## Arguments **`input`**: `UpdateMBomApprovalRoleInput!` (required) ## Returns `UpdateMBomApprovalRole` **`approvalRole`**: `MBomApprovalRole` ## Examples ```graphql Mutation mutation UpdateMbomApprovalRole($input: UpdateMBomApprovalRoleInput!) { updateMbomApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "gateType": "RELEASED", "roleId": 1 } } ``` ```json Response { "data": { "updateMbomApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateMbomAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateMbomAttribute Updates an attribute on a manufacturing bill of materials (mBOM). **mutation** `updateMbomAttribute(input: UpdateMbomAttributeInput!): UpdateMbomAttribute` ## Arguments **`input`**: `UpdateMbomAttributeInput!` (required) ## Returns `UpdateMbomAttribute` **`mbomAttribute`**: `MbomAttribute` ## Examples ```graphql Mutation mutation UpdateMbomAttribute($input: UpdateMbomAttributeInput!) { updateMbomAttribute(input: $input) { mbomAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "mbomId": 1 } } ``` ```json Response { "data": { "updateMbomAttribute": { "mbomAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateMbomItem Source: https://docs.firstresonance.io/api-reference/mutations/updateMbomItem **mutation** `updateMbomItem(input: UpdateMBomItemInput!): UpdateMBomItem` ## Arguments **`input`**: `UpdateMBomItemInput!` (required) ## Returns `UpdateMBomItem` **`mbomItem`**: `MBomItem` ## Examples ```graphql Mutation mutation UpdateMbomItem($input: UpdateMBomItemInput!) { updateMbomItem(input: $input) { mbomItem { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateMbomItem": { "mbomItem": { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } } } } ``` # updateMbomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/mutations/updateMbomItemReferenceDesignator **mutation** `updateMbomItemReferenceDesignator(input: UpdateMBomItemReferenceDesignatorInput!): UpdateMBomItemReferenceDesignator` ## Arguments **`input`**: `UpdateMBomItemReferenceDesignatorInput!` (required) ## Returns `UpdateMBomItemReferenceDesignator` **`mbomItemReferenceDesignator`**: `MBomItemReferenceDesignator` ## Examples ```graphql Mutation mutation UpdateMbomItemReferenceDesignator($input: UpdateMBomItemReferenceDesignatorInput!) { updateMbomItemReferenceDesignator(input: $input) { mbomItemReferenceDesignator { LastSessionId _BuildRequirementReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _created _etag } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateMbomItemReferenceDesignator": { "mbomItemReferenceDesignator": { "LastSessionId": "string", "_BuildRequirementReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_created": "value", "_etag": "string" } } } } ``` # updateMrpJob Source: https://docs.firstresonance.io/api-reference/mutations/updateMrpJob **mutation** `updateMrpJob(input: UpdateMRPJobInput!): UpdateMRPJob` ## Arguments **`input`**: `UpdateMRPJobInput!` (required) ## Returns `UpdateMRPJob` **`mrpJob`**: `MRPJob` ## Examples ```graphql Mutation mutation UpdateMrpJob($input: UpdateMRPJobInput!) { updateMrpJob(input: $input) { mrpJob { LastSessionId _CommentsCount _PlanItemsCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateMrpJob": { "mrpJob": { "LastSessionId": "string", "_CommentsCount": 1, "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateMultiplePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/updateMultiplePartInventory Updates multiple part inventory records. **mutation** `updateMultiplePartInventory(input: UpdateMultiplePartInventoryInput): UpdateMultiplePartInventory` ## Arguments **`input`**: `UpdateMultiplePartInventoryInput` ## Returns `UpdateMultiplePartInventory` **`partInventory`**: `[PartInventory]` --- **`splitInventory`**: `[PartInventory]` ## Examples ```graphql Mutation mutation UpdateMultiplePartInventory { updateMultiplePartInventory { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } splitInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "updateMultiplePartInventory": { "partInventory": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ], "splitInventory": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # updateOauthApp Source: https://docs.firstresonance.io/api-reference/mutations/updateOauthApp Update an OAuth application registration. **mutation** `updateOauthApp(_etag: String!, id: Int!, name: String!): UpdateOAuthApp` ## Arguments **`_etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`name`**: `String!` (required) ## Returns `UpdateOAuthApp` **`oauthApp`**: `OAuthAppRegistrationObject` ## Examples ```graphql Mutation mutation UpdateOauthApp($_etag: String!, $id: Int!, $name: String!) { updateOauthApp(_etag: $_etag, id: $id, name: $name) { oauthApp { _created _etag _updated appType callbackUris { _created createdById id uri uriType } clientId } } } ``` ```json Variables { "_etag": "string", "id": 1, "name": "string" } ``` ```json Response { "data": { "updateOauthApp": { "oauthApp": { "_created": "value", "_etag": "string", "_updated": "value", "appType": "string", "callbackUris": [ { "_created": "value", "createdById": 1, "id": 1, "uri": "string", "uriType": "string" } ], "clientId": "string" } } } } ``` # updateOrganization Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganization Updates the organization's settings. **mutation** `updateOrganization(input: UpdateOrganizationInput!): UpdateOrganization` ## Arguments **`input`**: `UpdateOrganizationInput!` (required) ## Returns `UpdateOrganization` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganization($input: UpdateOrganizationInput!) { updateOrganization(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateOrganization": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationBranding Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationBranding Update branding (logo, colors) for the organization's Auth0 login page. **mutation** `updateOrganizationBranding(logoUrl: String, pageBackgroundColor: String, primaryColor: String): UpdateOrganizationBranding` ## Arguments **`logoUrl`**: `String` --- **`pageBackgroundColor`**: `String` --- **`primaryColor`**: `String` ## Returns `UpdateOrganizationBranding` **`branding`**: `OrganizationBrandingType` --- **`success`**: `Boolean` ## Examples ```graphql Mutation mutation UpdateOrganizationBranding { updateOrganizationBranding { branding { logoUrl pageBackgroundColor primaryColor } success } } ``` ```json Response { "data": { "updateOrganizationBranding": { "branding": { "logoUrl": "string", "pageBackgroundColor": "string", "primaryColor": "string" }, "success": true } } } ``` # updateOrganizationFurtherActionAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationFurtherActionAttributes Updates the definition of further action attributes for the organization. **mutation** `updateOrganizationFurtherActionAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationFurtherActionAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationFurtherActionAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationFurtherActionAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationFurtherActionAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationFurtherActionAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationGlobalUniqueSerialNumberScheme Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationGlobalUniqueSerialNumberScheme Updates the global unique serial number scheme. **mutation** `updateOrganizationGlobalUniqueSerialNumberScheme(input: UpdateGlobalUniqueSerialNumberSchemeSettingInput!): UpdateOrganizationGlobalUniqueSerialNumberScheme` ## Arguments **`input`**: `UpdateGlobalUniqueSerialNumberSchemeSettingInput!` (required) ## Returns `UpdateOrganizationGlobalUniqueSerialNumberScheme` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationGlobalUniqueSerialNumberScheme($input: UpdateGlobalUniqueSerialNumberSchemeSettingInput!) { updateOrganizationGlobalUniqueSerialNumberScheme(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": 1, "name": "string" } } ``` ```json Response { "data": { "updateOrganizationGlobalUniqueSerialNumberScheme": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationIssueAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationIssueAttributes Updates the definition of issue attributes for the organization. **mutation** `updateOrganizationIssueAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationIssueAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationIssueAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationIssueAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationIssueAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationIssueAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationLocationAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationLocationAttributes Updates the definition of location attributes for the organization. **mutation** `updateOrganizationLocationAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationLocationAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationLocationAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationLocationAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationLocationAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationLocationAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationMbomAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationMbomAttributes Updates the definition of mBOM attributes for the organization. **mutation** `updateOrganizationMbomAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationMbomAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationMbomAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationMbomAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationMbomAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationMbomAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationMfaPolicy Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationMfaPolicy Enable or disable MFA requirement for the organization. **mutation** `updateOrganizationMfaPolicy(enabled: Boolean!): UpdateOrganizationMfaPolicy` ## Arguments **`enabled`**: `Boolean!` (required) ## Returns `UpdateOrganizationMfaPolicy` **`success`**: `Boolean` ## Examples ```graphql Mutation mutation UpdateOrganizationMfaPolicy($enabled: Boolean!) { updateOrganizationMfaPolicy(enabled: $enabled) { success } } ``` ```json Variables { "enabled": true } ``` ```json Response { "data": { "updateOrganizationMfaPolicy": { "success": true } } } ``` # updateOrganizationPartAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPartAttributes Updates the definition of part attributes for the organization. **mutation** `updateOrganizationPartAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPartAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPartAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPartAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPartAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPartAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPartInventoryAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPartInventoryAttributes Updates the definition of part inventory attributes for the organization. **mutation** `updateOrganizationPartInventoryAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPartInventoryAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPartInventoryAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPartInventoryAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPartInventoryAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPartInventoryAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPartKitAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPartKitAttributes Updates the definition of part kit attributes for the organization. **mutation** `updateOrganizationPartKitAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPartKitAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPartKitAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPartKitAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPartKitAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPartKitAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPartKitItemAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPartKitItemAttributes Updates the definition of part kit item attributes for the organization. **mutation** `updateOrganizationPartKitItemAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPartKitItemAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPartKitItemAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPartKitItemAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPartKitItemAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPartKitItemAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPartRevisionScheme Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPartRevisionScheme Updates the part revision scheme for the organization. **mutation** `updateOrganizationPartRevisionScheme(input: UpdatePartRevisionSchemeSettingInput!): UpdateOrganizationPartRevisionScheme` ## Arguments **`input`**: `UpdatePartRevisionSchemeSettingInput!` (required) ## Returns `UpdateOrganizationPartRevisionScheme` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPartRevisionScheme($input: UpdatePartRevisionSchemeSettingInput!) { updateOrganizationPartRevisionScheme(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "name": "string" } } ``` ```json Response { "data": { "updateOrganizationPartRevisionScheme": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPlanAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPlanAttributes Updates the definition of plan attributes for the organization. **mutation** `updateOrganizationPlanAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPlanAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPlanAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPlanAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPlanAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPlanAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationProcedureAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationProcedureAttributes Updates the definition of procedure attributes for the organization. **mutation** `updateOrganizationProcedureAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationProcedureAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationProcedureAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationProcedureAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationProcedureAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationProcedureAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPurchaseOrderAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPurchaseOrderAttributes Updates the definition of purchase order attributes for the organization. **mutation** `updateOrganizationPurchaseOrderAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPurchaseOrderAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPurchaseOrderAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPurchaseOrderAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPurchaseOrderAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPurchaseOrderAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationPurchaseOrderLineAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationPurchaseOrderLineAttributes Updates the definition of purchase order line attributes for the organization. **mutation** `updateOrganizationPurchaseOrderLineAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationPurchaseOrderLineAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationPurchaseOrderLineAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationPurchaseOrderLineAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationPurchaseOrderLineAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationPurchaseOrderLineAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationReceiptAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationReceiptAttributes Updates the definition of receipt attributes for the organization. **mutation** `updateOrganizationReceiptAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationReceiptAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationReceiptAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationReceiptAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationReceiptAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationReceiptAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationRunAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationRunAttributes Updates the definition of run attributes for the organization. **mutation** `updateOrganizationRunAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationRunAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationRunAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationRunAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationRunAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationRunAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationRunStepAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationRunStepAttributes Updates the definition of run step attributes for the organization. **mutation** `updateOrganizationRunStepAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationRunStepAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationRunStepAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationRunStepAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationRunStepAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationRunStepAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationStepAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationStepAttributes Updates the definition of step attributes for the organization. **mutation** `updateOrganizationStepAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationStepAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationStepAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationStepAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationStepAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationStepAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updateOrganizationSupplierAttributes Source: https://docs.firstresonance.io/api-reference/mutations/updateOrganizationSupplierAttributes Updates the definition of supplier attributes for the organization. **mutation** `updateOrganizationSupplierAttributes(input: UpdateAttributeSettingsInput!): UpdateOrganizationSupplierAttributes` ## Arguments **`input`**: `UpdateAttributeSettingsInput!` (required) ## Returns `UpdateOrganizationSupplierAttributes` **`organization`**: `Organization` ## Examples ```graphql Mutation mutation UpdateOrganizationSupplierAttributes($input: UpdateAttributeSettingsInput!) { updateOrganizationSupplierAttributes(input: $input) { organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } } ``` ```json Variables { "input": { "etag": "string", "id": "id", "key": "string" } } ``` ```json Response { "data": { "updateOrganizationSupplierAttributes": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } } ``` # updatePart Source: https://docs.firstresonance.io/api-reference/mutations/updatePart Updates an existing part. **mutation** `updatePart(input: UpdatePartInput!): UpdatePart` ## Arguments **`input`**: `UpdatePartInput!` (required) ## Returns `UpdatePart` **`part`**: `Part` ## Examples ```graphql Mutation mutation UpdatePart($input: UpdatePartInput!) { updatePart(input: $input) { part { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePart": { "part": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } } } } ``` # updatePartAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePartAttribute Updates an attribute on a part. **mutation** `updatePartAttribute(input: UpdatePartAttributeInput!): UpdatePartAttribute` ## Arguments **`input`**: `UpdatePartAttributeInput!` (required) ## Returns `UpdatePartAttribute` **`partAttribute`**: `PartAttribute` ## Examples ```graphql Mutation mutation UpdatePartAttribute($input: UpdatePartAttributeInput!) { updatePartAttribute(input: $input) { partAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "partId": 1 } } ``` ```json Response { "data": { "updatePartAttribute": { "partAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePartInventory Source: https://docs.firstresonance.io/api-reference/mutations/updatePartInventory Updates a part inventory record. **mutation** `updatePartInventory(input: UpdatePartInventoryInput): UpdatePartInventory` ## Arguments **`input`**: `UpdatePartInventoryInput` ## Returns `UpdatePartInventory` **`partInventory`**: `PartInventory` --- **`splitInventory`**: `PartInventory` ## Examples ```graphql Mutation mutation UpdatePartInventory { updatePartInventory { partInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } splitInventory { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "updatePartInventory": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 }, "splitInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updatePartInventoryAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePartInventoryAttribute Updates an attribute on a part inventory record. **mutation** `updatePartInventoryAttribute(input: UpdatePartInventoryAttributeInput!): UpdatePartInventoryAttribute` ## Arguments **`input`**: `UpdatePartInventoryAttributeInput!` (required) ## Returns `UpdatePartInventoryAttribute` **`partInventoryAttribute`**: `PartInventoryAttribute` ## Examples ```graphql Mutation mutation UpdatePartInventoryAttribute($input: UpdatePartInventoryAttributeInput!) { updatePartInventoryAttribute(input: $input) { partInventoryAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "partInventoryId": 1 } } ``` ```json Response { "data": { "updatePartInventoryAttribute": { "partInventoryAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePartKit Source: https://docs.firstresonance.io/api-reference/mutations/updatePartKit **mutation** `updatePartKit(input: UpdatePartKitInput!): UpdatePartKit` ## Arguments **`input`**: `UpdatePartKitInput!` (required) ## Returns `UpdatePartKit` **`partKit`**: `PartKit` ## Examples ```graphql Mutation mutation UpdatePartKit($input: UpdatePartKitInput!) { updatePartKit(input: $input) { partKit { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updatePartKit": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } } ``` # updatePartKitAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePartKitAttribute Updates an attribute on a part kit. **mutation** `updatePartKitAttribute(input: UpdatePartKitAttributeInput!): UpdatePartKitAttribute` ## Arguments **`input`**: `UpdatePartKitAttributeInput!` (required) ## Returns `UpdatePartKitAttribute` **`partKitAttribute`**: `PartKitAttribute` ## Examples ```graphql Mutation mutation UpdatePartKitAttribute($input: UpdatePartKitAttributeInput!) { updatePartKitAttribute(input: $input) { partKitAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "partKitId": 1 } } ``` ```json Response { "data": { "updatePartKitAttribute": { "partKitAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePartKitItem Source: https://docs.firstresonance.io/api-reference/mutations/updatePartKitItem **mutation** `updatePartKitItem(input: UpdatePartKitItemInput!): UpdatePartKitItem` ## Arguments **`input`**: `UpdatePartKitItemInput!` (required) ## Returns `UpdatePartKitItem` **`partKitItem`**: `PartKitItem` ## Examples ```graphql Mutation mutation UpdatePartKitItem($input: UpdatePartKitItemInput!) { updatePartKitItem(input: $input) { partKitItem { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updatePartKitItem": { "partKitItem": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # updatePartKitItemAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePartKitItemAttribute Updates an attribute on an item within a part kit. **mutation** `updatePartKitItemAttribute(input: UpdatePartKitItemAttributeInput!): UpdatePartKitItemAttribute` ## Arguments **`input`**: `UpdatePartKitItemAttributeInput!` (required) ## Returns `UpdatePartKitItemAttribute` **`partKitItemAttribute`**: `PartKitItemAttribute` ## Examples ```graphql Mutation mutation UpdatePartKitItemAttribute($input: UpdatePartKitItemAttributeInput!) { updatePartKitItemAttribute(input: $input) { partKitItemAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "partKitItemId": 1 } } ``` ```json Response { "data": { "updatePartKitItemAttribute": { "partKitItemAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePartKits Source: https://docs.firstresonance.io/api-reference/mutations/updatePartKits **mutation** `updatePartKits(input: [UpdatePartKitInput]): UpdatePartKits` ## Arguments **`input`**: `[UpdatePartKitInput]` ## Returns `UpdatePartKits` **`partKits`**: `[PartKit]` ## Examples ```graphql Mutation mutation UpdatePartKits { updatePartKits { partKits { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } } ``` ```json Response { "data": { "updatePartKits": { "partKits": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } ] } } } ``` # updatePartProcedure Source: https://docs.firstresonance.io/api-reference/mutations/updatePartProcedure **mutation** `updatePartProcedure(input: UpdatePartProcedureInput!): UpdatePartProcedure` ## Arguments **`input`**: `UpdatePartProcedureInput!` (required) ## Returns `UpdatePartProcedure` **`partProcedure`**: `PartProcedure` ## Examples ```graphql Mutation mutation UpdatePartProcedure($input: UpdatePartProcedureInput!) { updatePartProcedure(input: $input) { partProcedure { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } } ``` ```json Variables { "input": { "etag": "string", "partId": "id", "procedureId": "id" } } ``` ```json Response { "data": { "updatePartProcedure": { "partProcedure": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } } ``` # updatePartSubtype Source: https://docs.firstresonance.io/api-reference/mutations/updatePartSubtype **mutation** `updatePartSubtype(input: UpdatePartSubtypeInput!): UpdatePartSubtype` ## Arguments **`input`**: `UpdatePartSubtypeInput!` (required) ## Returns `UpdatePartSubtype` **`partSubtype`**: `PartSubtype` ## Examples ```graphql Mutation mutation UpdatePartSubtype($input: UpdatePartSubtypeInput!) { updatePartSubtype(input: $input) { partSubtype { LastSessionId _PartsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePartSubtype": { "partSubtype": { "LastSessionId": "string", "_PartsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updatePlan Source: https://docs.firstresonance.io/api-reference/mutations/updatePlan **mutation** `updatePlan(input: UpdatePlanInput!): UpdatePlan` ## Arguments **`input`**: `UpdatePlanInput!` (required) ## Returns `UpdatePlan` **`plan`**: `Plan` ## Examples ```graphql Mutation mutation UpdatePlan($input: UpdatePlanInput!) { updatePlan(input: $input) { plan { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updatePlan": { "plan": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # updatePlanAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePlanAttribute Updates an attribute on a plan. **mutation** `updatePlanAttribute(input: UpdatePlanAttributeInput!): UpdatePlanAttribute` ## Arguments **`input`**: `UpdatePlanAttributeInput!` (required) ## Returns `UpdatePlanAttribute` **`planAttribute`**: `PlanAttribute` ## Examples ```graphql Mutation mutation UpdatePlanAttribute($input: UpdatePlanAttributeInput!) { updatePlanAttribute(input: $input) { planAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "planId": 1 } } ``` ```json Response { "data": { "updatePlanAttribute": { "planAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePlanConstraint Source: https://docs.firstresonance.io/api-reference/mutations/updatePlanConstraint **mutation** `updatePlanConstraint(input: UpdatePlanConstraintInput!): UpdatePlanConstraint` ## Arguments **`input`**: `UpdatePlanConstraintInput!` (required) ## Returns `UpdatePlanConstraint` **`planConstraint`**: `PlanConstraint` ## Examples ```graphql Mutation mutation UpdatePlanConstraint($input: UpdatePlanConstraintInput!) { updatePlanConstraint(input: $input) { planConstraint { LastSessionId _PlanConstraintLocationsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updatePlanConstraint": { "planConstraint": { "LastSessionId": "string", "_PlanConstraintLocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updatePlanItem Source: https://docs.firstresonance.io/api-reference/mutations/updatePlanItem **mutation** `updatePlanItem(input: UpdatePlanItemInput!): UpdatePlanItem` ## Arguments **`input`**: `UpdatePlanItemInput!` (required) ## Returns `UpdatePlanItem` **`planItem`**: `PlanItem` ## Examples ```graphql Mutation mutation UpdatePlanItem($input: UpdatePlanItemInput!) { updatePlanItem(input: $input) { planItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePlanItem": { "planItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } } } ``` # updatePlanItemAllocation Source: https://docs.firstresonance.io/api-reference/mutations/updatePlanItemAllocation **mutation** `updatePlanItemAllocation(input: UpdatePlanItemAllocationInput!): UpdatePlanItemAllocation` ## Arguments **`input`**: `UpdatePlanItemAllocationInput!` (required) ## Returns `UpdatePlanItemAllocation` **`planItemAllocation`**: `PlanItemAllocation` ## Examples ```graphql Mutation mutation UpdatePlanItemAllocation($input: UpdatePlanItemAllocationInput!) { updatePlanItemAllocation(input: $input) { planItemAllocation { LastSessionId _created _etag _updated childPlanItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } childPlanItemId } } } ``` ```json Variables { "input": { "childPlanItemId": "id", "etag": "string", "parentPlanItemId": "id" } } ``` ```json Response { "data": { "updatePlanItemAllocation": { "planItemAllocation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "childPlanItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 }, "childPlanItemId": 1 } } } } ``` # updatePlanReservation Source: https://docs.firstresonance.io/api-reference/mutations/updatePlanReservation **mutation** `updatePlanReservation(input: UpdatePlanReservationInput!): UpdatePlanReservation` ## Arguments **`input`**: `UpdatePlanReservationInput!` (required) ## Returns `UpdatePlanReservation` **`planReservation`**: `PlanReservation` ## Examples ```graphql Mutation mutation UpdatePlanReservation($input: UpdatePlanReservationInput!) { updatePlanReservation(input: $input) { planReservation { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePlanReservation": { "planReservation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateProcedure Source: https://docs.firstresonance.io/api-reference/mutations/updateProcedure Updates an existing procedure. This can be used to change the procedure's name, description, or other properties. **mutation** `updateProcedure(input: UpdateProcedureInput!): UpdateProcedure` ## Arguments **`input`**: `UpdateProcedureInput!` (required) ## Returns `UpdateProcedure` **`procedure`**: `Procedure` ## Examples ```graphql Mutation mutation UpdateProcedure($input: UpdateProcedureInput!) { updateProcedure(input: $input) { procedure { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateProcedure": { "procedure": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateProcedureApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateProcedureApproval **mutation** `updateProcedureApproval(input: UpdateProcedureApprovalInput!): UpdateProcedureApproval` ## Arguments **`input`**: `UpdateProcedureApprovalInput!` (required) ## Returns `UpdateProcedureApproval` **`approval`**: `ProcedureApproval` ## Examples ```graphql Mutation mutation UpdateProcedureApproval($input: UpdateProcedureApprovalInput!) { updateProcedureApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateProcedureApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateProcedureApprovalRequest **mutation** `updateProcedureApprovalRequest(input: UpdateProcedureApprovalRequestInput!): UpdateProcedureApprovalRequest` ## Arguments **`input`**: `UpdateProcedureApprovalRequestInput!` (required) ## Returns `UpdateProcedureApprovalRequest` **`approvalRequest`**: `ProcedureApprovalRequest` ## Examples ```graphql Mutation mutation UpdateProcedureApprovalRequest($input: UpdateProcedureApprovalRequestInput!) { updateProcedureApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateProcedureApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/updateProcedureApprovalRole **mutation** `updateProcedureApprovalRole(input: UpdateProcedureApprovalRoleInput!): UpdateProcedureApprovalRole` ## Arguments **`input`**: `UpdateProcedureApprovalRoleInput!` (required) ## Returns `UpdateProcedureApprovalRole` **`approvalRole`**: `ProcedureApprovalRole` ## Examples ```graphql Mutation mutation UpdateProcedureApprovalRole($input: UpdateProcedureApprovalRoleInput!) { updateProcedureApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "gateType": "RELEASED", "roleId": 1 } } ``` ```json Response { "data": { "updateProcedureApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateProcedureAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateProcedureAttribute Updates an attribute on a procedure. Attributes are custom fields that can be added to procedures. **mutation** `updateProcedureAttribute(input: UpdateProcedureAttributeInput!): UpdateProcedureAttribute` ## Arguments **`input`**: `UpdateProcedureAttributeInput!` (required) ## Returns `UpdateProcedureAttribute` **`procedureAttribute`**: `ProcedureAttribute` ## Examples ```graphql Mutation mutation UpdateProcedureAttribute($input: UpdateProcedureAttributeInput!) { updateProcedureAttribute(input: $input) { procedureAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "procedureId": 1 } } ``` ```json Response { "data": { "updateProcedureAttribute": { "procedureAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateProject Source: https://docs.firstresonance.io/api-reference/mutations/updateProject **mutation** `updateProject(input: UpdateProjectInput!): UpdateProject` ## Arguments **`input`**: `UpdateProjectInput!` (required) ## Returns `UpdateProject` **`project`**: `Project` ## Examples ```graphql Mutation mutation UpdateProject($input: UpdateProjectInput!) { updateProject(input: $input) { project { LastSessionId _created _etag _updated archived code } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateProject": { "project": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } } } ``` # updatePurchaseOrder Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrder **mutation** `updatePurchaseOrder(input: UpdatePurchaseOrderInput!): UpdatePurchaseOrder` ## Arguments **`input`**: `UpdatePurchaseOrderInput!` (required) ## Returns `UpdatePurchaseOrder` **`purchaseOrder`**: `PurchaseOrder` ## Examples ```graphql Mutation mutation UpdatePurchaseOrder($input: UpdatePurchaseOrderInput!) { updatePurchaseOrder(input: $input) { purchaseOrder { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalLevelsCount _ApprovalRequestsCount _ApprovalsCount _AssigneesCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updatePurchaseOrder": { "purchaseOrder": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalLevelsCount": 1, "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1 } } } } ``` # updatePurchaseOrderApproval Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderApproval **mutation** `updatePurchaseOrderApproval(input: UpdatePurchaseOrderApprovalInput!): UpdatePurchaseOrderApproval` ## Arguments **`input`**: `UpdatePurchaseOrderApprovalInput!` (required) ## Returns `UpdatePurchaseOrderApproval` **`approval`**: `PurchaseOrderApproval` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderApproval($input: UpdatePurchaseOrderApprovalInput!) { updatePurchaseOrderApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePurchaseOrderApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updatePurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderApprovalLevel **mutation** `updatePurchaseOrderApprovalLevel(input: UpdatePurchaseOrderApprovalLevelInput!): UpdatePurchaseOrderApprovalLevel` ## Arguments **`input`**: `UpdatePurchaseOrderApprovalLevelInput!` (required) ## Returns `UpdatePurchaseOrderApprovalLevel` **`purchaseOrderApprovalLevel`**: `PurchaseOrderApprovalLevel` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderApprovalLevel($input: UpdatePurchaseOrderApprovalLevelInput!) { updatePurchaseOrderApprovalLevel(input: $input) { purchaseOrderApprovalLevel { LastSessionId _CandidateUsersCount _created _etag _updated approvalLevel { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePurchaseOrderApprovalLevel": { "purchaseOrderApprovalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "approvalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } } ``` # updatePurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderApprovalRequest **mutation** `updatePurchaseOrderApprovalRequest(input: UpdatePurchaseOrderApprovalRequestInput!): UpdatePurchaseOrderApprovalRequest` ## Arguments **`input`**: `UpdatePurchaseOrderApprovalRequestInput!` (required) ## Returns `UpdatePurchaseOrderApprovalRequest` **`approvalRequest`**: `PurchaseOrderApprovalRequest` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderApprovalRequest($input: UpdatePurchaseOrderApprovalRequestInput!) { updatePurchaseOrderApprovalRequest(input: $input) { approvalRequest { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePurchaseOrderApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updatePurchaseOrderAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderAttribute Updates an attribute on a purchase order. **mutation** `updatePurchaseOrderAttribute(input: UpdatePurchaseOrderAttributeInput!): UpdatePurchaseOrderAttribute` ## Arguments **`input`**: `UpdatePurchaseOrderAttributeInput!` (required) ## Returns `UpdatePurchaseOrderAttribute` **`purchaseOrderAttribute`**: `PurchaseOrderAttribute` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderAttribute($input: UpdatePurchaseOrderAttributeInput!) { updatePurchaseOrderAttribute(input: $input) { purchaseOrderAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "purchaseOrderId": 1 } } ``` ```json Response { "data": { "updatePurchaseOrderAttribute": { "purchaseOrderAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderFee **mutation** `updatePurchaseOrderFee(input: UpdatePurchaseOrderFeeInput!): UpdatePurchaseOrderFee` ## Arguments **`input`**: `UpdatePurchaseOrderFeeInput!` (required) ## Returns `UpdatePurchaseOrderFee` **`purchaseOrderFee`**: `PurchaseOrderFee` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderFee($input: UpdatePurchaseOrderFeeInput!) { updatePurchaseOrderFee(input: $input) { purchaseOrderFee { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updatePurchaseOrderFee": { "purchaseOrderFee": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updatePurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderLine Updates a line item on a purchase order. **mutation** `updatePurchaseOrderLine(input: UpdatePurchaseOrderLineInput!): UpdatePurchaseOrderLine` ## Arguments **`input`**: `UpdatePurchaseOrderLineInput!` (required) ## Returns `UpdatePurchaseOrderLine` **`purchaseOrderLine`**: `PurchaseOrderLine` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderLine($input: UpdatePurchaseOrderLineInput!) { updatePurchaseOrderLine(input: $input) { purchaseOrderLine { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updatePurchaseOrderLine": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # updatePurchaseOrderLineAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderLineAttribute Updates an attribute on a purchase order line item. **mutation** `updatePurchaseOrderLineAttribute(input: UpdatePurchaseOrderLineAttributeInput!): UpdatePurchaseOrderLineAttribute` ## Arguments **`input`**: `UpdatePurchaseOrderLineAttributeInput!` (required) ## Returns `UpdatePurchaseOrderLineAttribute` **`purchaseOrderLineAttribute`**: `PurchaseOrderLineAttribute` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderLineAttribute($input: UpdatePurchaseOrderLineAttributeInput!) { updatePurchaseOrderLineAttribute(input: $input) { purchaseOrderLineAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "purchaseOrderLineId": 1 } } ``` ```json Response { "data": { "updatePurchaseOrderLineAttribute": { "purchaseOrderLineAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updatePurchaseOrderLines Source: https://docs.firstresonance.io/api-reference/mutations/updatePurchaseOrderLines **mutation** `updatePurchaseOrderLines(input: [UpdatePurchaseOrderLineInput]): UpdatePurchaseOrderLines` ## Arguments **`input`**: `[UpdatePurchaseOrderLineInput]` ## Returns `UpdatePurchaseOrderLines` **`purchaseOrderLines`**: `[PurchaseOrderLine]` ## Examples ```graphql Mutation mutation UpdatePurchaseOrderLines { updatePurchaseOrderLines { purchaseOrderLines { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Response { "data": { "updatePurchaseOrderLines": { "purchaseOrderLines": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } ] } } } ``` # updateReceipt Source: https://docs.firstresonance.io/api-reference/mutations/updateReceipt **mutation** `updateReceipt(input: UpdateReceiptInput!): UpdateReceipt` ## Arguments **`input`**: `UpdateReceiptInput!` (required) ## Returns `UpdateReceipt` **`receipt`**: `Receipt` ## Examples ```graphql Mutation mutation UpdateReceipt($input: UpdateReceiptInput!) { updateReceipt(input: $input) { receipt { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateReceipt": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # updateReceiptAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateReceiptAttribute Updates an attribute on a receipt. **mutation** `updateReceiptAttribute(input: UpdateReceiptAttributeInput!): UpdateReceiptAttribute` ## Arguments **`input`**: `UpdateReceiptAttributeInput!` (required) ## Returns `UpdateReceiptAttribute` **`receiptAttribute`**: `ReceiptAttribute` ## Examples ```graphql Mutation mutation UpdateReceiptAttribute($input: UpdateReceiptAttributeInput!) { updateReceiptAttribute(input: $input) { receiptAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "receiptId": 1 } } ``` ```json Response { "data": { "updateReceiptAttribute": { "receiptAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateReceiptItem Source: https://docs.firstresonance.io/api-reference/mutations/updateReceiptItem **mutation** `updateReceiptItem(input: UpdateReceiptItemInput!): UpdateReceiptItem` ## Arguments **`input`**: `UpdateReceiptItemInput!` (required) ## Returns `UpdateReceiptItem` **`receiptItem`**: `ReceiptItem` ## Examples ```graphql Mutation mutation UpdateReceiptItem($input: UpdateReceiptItemInput!) { updateReceiptItem(input: $input) { receiptItem { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateReceiptItem": { "receiptItem": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateRedline Source: https://docs.firstresonance.io/api-reference/mutations/updateRedline **mutation** `updateRedline(input: UpdateRedlineInput!): UpdateRedline` ## Arguments **`input`**: `UpdateRedlineInput!` (required) ## Returns `UpdateRedline` **`redline`**: `Redline` ## Examples ```graphql Mutation mutation UpdateRedline($input: UpdateRedlineInput!) { updateRedline(input: $input) { redline { LastSessionId _ApprovalRequestsCount _ApprovalsCount _RoleBasedApprovalRequestsCount _RoleBasedApprovalsCount _TargetRedlinesCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRedline": { "redline": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_RoleBasedApprovalRequestsCount": 1, "_RoleBasedApprovalsCount": 1, "_TargetRedlinesCount": 1 } } } } ``` # updateRedlineApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineApproval **mutation** `updateRedlineApproval(input: UpdateRedlineApprovalInput!): UpdateRedlineApproval` ## Arguments **`input`**: `UpdateRedlineApprovalInput!` (required) ## Returns `UpdateRedlineApproval` **`approval`**: `RedlineApproval` ## Examples ```graphql Mutation mutation UpdateRedlineApproval($input: UpdateRedlineApprovalInput!) { updateRedlineApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated batchSiblings { __typename } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRedlineApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApproval" } ] } } } } ``` # updateRedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineApprovalRequest **mutation** `updateRedlineApprovalRequest(input: UpdateRedlineApprovalRequestInput!): UpdateRedlineApprovalRequest` ## Arguments **`input`**: `UpdateRedlineApprovalRequestInput!` (required) ## Returns `UpdateRedlineApprovalRequest` **`approvalRequest`**: `RedlineApprovalRequest` ## Examples ```graphql Mutation mutation UpdateRedlineApprovalRequest($input: UpdateRedlineApprovalRequestInput!) { updateRedlineApprovalRequest(input: $input) { approvalRequest { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRedlineApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApprovalRequest" } ], "batched": "string" } } } } ``` # updateRedlineApprovalRequests Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineApprovalRequests **mutation** `updateRedlineApprovalRequests(input: [UpdateRedlineApprovalRequestInput]): UpdateRedlineApprovalRequests` ## Arguments **`input`**: `[UpdateRedlineApprovalRequestInput]` ## Returns `UpdateRedlineApprovalRequests` **`approvalRequests`**: `[RedlineApprovalRequest]` ## Examples ```graphql Mutation mutation UpdateRedlineApprovalRequests { updateRedlineApprovalRequests { approvalRequests { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } } ``` ```json Response { "data": { "updateRedlineApprovalRequests": { "approvalRequests": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApprovalRequest" } ], "batched": "string" } ] } } } ``` # updateRedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineApprovalRole **mutation** `updateRedlineApprovalRole(input: UpdateRedlineApprovalRoleInput!): UpdateRedlineApprovalRole` ## Arguments **`input`**: `UpdateRedlineApprovalRoleInput!` (required) ## Returns `UpdateRedlineApprovalRole` **`approvalRole`**: `RedlineApprovalRole` ## Examples ```graphql Mutation mutation UpdateRedlineApprovalRole($input: UpdateRedlineApprovalRoleInput!) { updateRedlineApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "gateType": "CLOSED", "roleId": 1 } } ``` ```json Response { "data": { "updateRedlineApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateRedlineRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineRoleBasedApproval **mutation** `updateRedlineRoleBasedApproval(input: UpdateRedlineRoleBasedApprovalInput!): UpdateRedlineRoleBasedApproval` ## Arguments **`input`**: `UpdateRedlineRoleBasedApprovalInput!` (required) ## Returns `UpdateRedlineRoleBasedApproval` **`approval`**: `RedlineRoleBasedApproval` ## Examples ```graphql Mutation mutation UpdateRedlineRoleBasedApproval($input: UpdateRedlineRoleBasedApprovalInput!) { updateRedlineRoleBasedApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated batched } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRedlineRoleBasedApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batched": "string" } } } } ``` # updateRedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineRoleBasedApprovalRequest **mutation** `updateRedlineRoleBasedApprovalRequest(input: UpdateRedlineRoleBasedApprovalRequestInput!): UpdateRedlineRoleBasedApprovalRequest` ## Arguments **`input`**: `UpdateRedlineRoleBasedApprovalRequestInput!` (required) ## Returns `UpdateRedlineRoleBasedApprovalRequest` **`approvalRequest`**: `RedlineRoleBasedApprovalRequest` ## Examples ```graphql Mutation mutation UpdateRedlineRoleBasedApprovalRequest($input: UpdateRedlineRoleBasedApprovalRequestInput!) { updateRedlineRoleBasedApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRedlineRoleBasedApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateRedlineRoleBasedApprovalRequests Source: https://docs.firstresonance.io/api-reference/mutations/updateRedlineRoleBasedApprovalRequests **mutation** `updateRedlineRoleBasedApprovalRequests(input: [UpdateRedlineRoleBasedApprovalRequestInput]): UpdateRedlineRoleBasedApprovalRequests` ## Arguments **`input`**: `[UpdateRedlineRoleBasedApprovalRequestInput]` ## Returns `UpdateRedlineRoleBasedApprovalRequests` **`approvalRequests`**: `[RedlineRoleBasedApprovalRequest]` ## Examples ```graphql Mutation mutation UpdateRedlineRoleBasedApprovalRequests { updateRedlineRoleBasedApprovalRequests { approvalRequests { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Response { "data": { "updateRedlineRoleBasedApprovalRequests": { "approvalRequests": [ { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } ] } } } ``` # updateRequirement Source: https://docs.firstresonance.io/api-reference/mutations/updateRequirement **mutation** `updateRequirement(input: UpdateRequirementInput!): UpdateRequirement` ## Arguments **`input`**: `UpdateRequirementInput!` (required) ## Returns `UpdateRequirement` **`requirement`**: `Requirement` ## Examples ```graphql Mutation mutation UpdateRequirement($input: UpdateRequirementInput!) { updateRequirement(input: $input) { requirement { LastSessionId _created _etag _updated content createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRequirement": { "requirement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "content": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateReview Source: https://docs.firstresonance.io/api-reference/mutations/updateReview **mutation** `updateReview(input: UpdateReviewInput!): UpdateReview` ## Arguments **`input`**: `UpdateReviewInput!` (required) ## Returns `UpdateReview` **`review`**: `Review` ## Examples ```graphql Mutation mutation UpdateReview($input: UpdateReviewInput!) { updateReview(input: $input) { review { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateReview": { "review": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateReviewRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateReviewRequest **mutation** `updateReviewRequest(input: UpdateReviewRequestInput!): UpdateReviewRequest` ## Arguments **`input`**: `UpdateReviewRequestInput!` (required) ## Returns `UpdateReviewRequest` **`reviewRequest`**: `ReviewRequest` ## Examples ```graphql Mutation mutation UpdateReviewRequest($input: UpdateReviewRequestInput!) { updateReviewRequest(input: $input) { reviewRequest { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateReviewRequest": { "reviewRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateRole Source: https://docs.firstresonance.io/api-reference/mutations/updateRole **mutation** `updateRole(input: UpdateRoleInput!): UpdateRole` ## Arguments **`input`**: `UpdateRoleInput!` (required) ## Returns `UpdateRole` **`role`**: `Role` ## Examples ```graphql Mutation mutation UpdateRole($input: UpdateRoleInput!) { updateRole(input: $input) { role { LastSessionId _IssueApprovalRequestsCount _IssueApprovalsCount _IssueDispositionTypeRolesCount _PermissionGroupRolesCount _PermissionGroupsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRole": { "role": { "LastSessionId": "string", "_IssueApprovalRequestsCount": 1, "_IssueApprovalsCount": 1, "_IssueDispositionTypeRolesCount": 1, "_PermissionGroupRolesCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # updateRule Source: https://docs.firstresonance.io/api-reference/mutations/updateRule **mutation** `updateRule(input: UpdateRuleInput!): UpdateRule` ## Arguments **`input`**: `UpdateRuleInput!` (required) ## Returns `UpdateRule` **`rule`**: `Rule` ## Examples ```graphql Mutation mutation UpdateRule($input: UpdateRuleInput!) { updateRule(input: $input) { rule { LastSessionId _ExecutionLogsCount _created _etag _updated aiDescription } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateRule": { "rule": { "LastSessionId": "string", "_ExecutionLogsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "aiDescription": "string" } } } } ``` # updateRun Source: https://docs.firstresonance.io/api-reference/mutations/updateRun **mutation** `updateRun(input: UpdateRunInput!): UpdateRun` ## Arguments **`input`**: `UpdateRunInput!` (required) ## Returns `UpdateRun` **`run`**: `Run` ## Examples ```graphql Mutation mutation UpdateRun($input: UpdateRunInput!) { updateRun(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRun": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateRunAbomJustification Source: https://docs.firstresonance.io/api-reference/mutations/updateRunAbomJustification Updates the ABOM completion justification text on a run (for auto-save). **mutation** `updateRunAbomJustification(input: UpdateRunAbomJustificationInput!): UpdateRunAbomJustification` ## Arguments **`input`**: `UpdateRunAbomJustificationInput!` (required) ## Returns `UpdateRunAbomJustification` **`run`**: `Run` ## Examples ```graphql Mutation mutation UpdateRunAbomJustification($input: UpdateRunAbomJustificationInput!) { updateRunAbomJustification(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "justification": "string", "runId": 1 } } ``` ```json Response { "data": { "updateRunAbomJustification": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateRunAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateRunAttribute Updates an attribute on a run. **mutation** `updateRunAttribute(input: UpdateRunAttributeInput!): UpdateRunAttribute` ## Arguments **`input`**: `UpdateRunAttributeInput!` (required) ## Returns `UpdateRunAttribute` **`runAttribute`**: `RunAttribute` ## Examples ```graphql Mutation mutation UpdateRunAttribute($input: UpdateRunAttributeInput!) { updateRunAttribute(input: $input) { runAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "runId": 1 } } ``` ```json Response { "data": { "updateRunAttribute": { "runAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateRunBatch Source: https://docs.firstresonance.io/api-reference/mutations/updateRunBatch **mutation** `updateRunBatch(input: UpdateRunBatchInput!): UpdateRunBatch` ## Arguments **`input`**: `UpdateRunBatchInput!` (required) ## Returns `UpdateRunBatch` **`runBatch`**: `RunBatch` ## Examples ```graphql Mutation mutation UpdateRunBatch($input: UpdateRunBatchInput!) { updateRunBatch(input: $input) { runBatch { LastSessionId _RunsCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRunBatch": { "runBatch": { "LastSessionId": "string", "_RunsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateRunInventoryLocation Source: https://docs.firstresonance.io/api-reference/mutations/updateRunInventoryLocation Updates the location of inventory associated with a run. **mutation** `updateRunInventoryLocation(input: UpdateRunInventoryLocationInput!): UpdateRunInventoryLocation` ## Arguments **`input`**: `UpdateRunInventoryLocationInput!` (required) ## Returns `UpdateRunInventoryLocation` **`run`**: `Run` ## Examples ```graphql Mutation mutation UpdateRunInventoryLocation($input: UpdateRunInventoryLocationInput!) { updateRunInventoryLocation(input: $input) { run { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "input": { "locationId": "id", "runId": "id" } } ``` ```json Response { "data": { "updateRunInventoryLocation": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } } ``` # updateRunStep Source: https://docs.firstresonance.io/api-reference/mutations/updateRunStep Updates an existing run step. This can be used to change its state or other properties. **mutation** `updateRunStep(input: UpdateRunStepInput!): UpdateRunStep` ## Arguments **`input`**: `UpdateRunStepInput!` (required) ## Returns `UpdateRunStep` **`dispositionApplied`**: `Boolean` Whether the requested output inventory disposition reached the run's output inventory. False when the run stayed open or had no eligible output. Null when no disposition was requested. --- **`runStep`**: `RunStep` ## Examples ```graphql Mutation mutation UpdateRunStep($input: UpdateRunStepInput!) { updateRunStep(input: $input) { dispositionApplied runStep { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { __typename } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRunStep": { "dispositionApplied": true, "runStep": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "__typename": "User" } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } } ``` # updateRunStepAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateRunStepAttribute Updates an attribute on a run step. **mutation** `updateRunStepAttribute(input: UpdateRunStepAttributeInput!): UpdateRunStepAttribute` ## Arguments **`input`**: `UpdateRunStepAttributeInput!` (required) ## Returns `UpdateRunStepAttribute` **`runStepAttribute`**: `RunStepAttribute` ## Examples ```graphql Mutation mutation UpdateRunStepAttribute($input: UpdateRunStepAttributeInput!) { updateRunStepAttribute(input: $input) { runStepAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "runStepId": 1 } } ``` ```json Response { "data": { "updateRunStepAttribute": { "runStepAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateRunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/mutations/updateRunStepBuildRequirement Updates a run step's per-step build-requirement quantity, enforcing the aBOM quantity invariant and installed floor. **mutation** `updateRunStepBuildRequirement(input: UpdateRunStepBuildRequirementInput!): UpdateRunStepBuildRequirement` ## Arguments **`input`**: `UpdateRunStepBuildRequirementInput!` (required) ## Returns `UpdateRunStepBuildRequirement` **`runStepBuildRequirement`**: `RunStepBuildRequirementMaterialized` ## Examples ```graphql Mutation mutation UpdateRunStepBuildRequirement($input: UpdateRunStepBuildRequirementInput!) { updateRunStepBuildRequirement(input: $input) { runStepBuildRequirement { Deleted LastSessionId _AbomInstallationsCount _AssignedAndInstalledReferenceDesignatorsCount _AssignedReferenceDesignatorsCount _InstalledReferenceDesignatorsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "string", "quantity": 1.5 } } ``` ```json Response { "data": { "updateRunStepBuildRequirement": { "runStepBuildRequirement": { "Deleted": true, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AssignedAndInstalledReferenceDesignatorsCount": 1.5, "_AssignedReferenceDesignatorsCount": 1, "_InstalledReferenceDesignatorsCount": 1.5 } } } } ``` # updateRunStepField Source: https://docs.firstresonance.io/api-reference/mutations/updateRunStepField Updates a field on a run step. This is different from updating the field's value. **mutation** `updateRunStepField(input: UpdateRunStepFieldInput!): UpdateRunStepField` ## Arguments **`input`**: `UpdateRunStepFieldInput!` (required) ## Returns `UpdateRunStepField` **`runStepField`**: `RunStepField` ## Examples ```graphql Mutation mutation UpdateRunStepField($input: UpdateRunStepFieldInput!) { updateRunStepField(input: $input) { runStepField { LastSessionId _AssigneesCount _IonValueCount _ValidationsCount _ValueCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRunStepField": { "runStepField": { "LastSessionId": "string", "_AssigneesCount": 1, "_IonValueCount": 1, "_ValidationsCount": 1, "_ValueCount": 1, "_created": "value" } } } } ``` # updateRunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/mutations/updateRunStepFieldValidation **mutation** `updateRunStepFieldValidation(input: UpdateRunStepFieldValidationInput!): UpdateRunStepFieldValidation` ## Arguments **`input`**: `UpdateRunStepFieldValidationInput!` (required) ## Returns `UpdateRunStepFieldValidation` **`runStepFieldValidation`**: `RunStepFieldValidation` ## Examples ```graphql Mutation mutation UpdateRunStepFieldValidation($input: UpdateRunStepFieldValidationInput!) { updateRunStepFieldValidation(input: $input) { runStepFieldValidation { LastSessionId _created _etag _updated allBatchedSiblings { __typename } batchAdoptedSiblings { __typename } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRunStepFieldValidation": { "runStepFieldValidation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "RunStepFieldValidation" } ], "batchAdoptedSiblings": [ { "__typename": "RunStepFieldValidation" } ] } } } } ``` # updateRunStepFieldValue Source: https://docs.firstresonance.io/api-reference/mutations/updateRunStepFieldValue Updates the value of a field on a run step. This is where data collected during the run is stored. **mutation** `updateRunStepFieldValue(input: UpdateRunStepFieldValueInput!): UpdateRunStepFieldValue` ## Arguments **`input`**: `UpdateRunStepFieldValueInput!` (required) ## Returns `UpdateRunStepFieldValue` **`runStepField`**: `RunStepField` ## Examples ```graphql Mutation mutation UpdateRunStepFieldValue($input: UpdateRunStepFieldValueInput!) { updateRunStepFieldValue(input: $input) { runStepField { LastSessionId _AssigneesCount _IonValueCount _ValidationsCount _ValueCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateRunStepFieldValue": { "runStepField": { "LastSessionId": "string", "_AssigneesCount": 1, "_IonValueCount": 1, "_ValidationsCount": 1, "_ValueCount": 1, "_created": "value" } } } } ``` # updateRuns Source: https://docs.firstresonance.io/api-reference/mutations/updateRuns Updates one or more runs. **mutation** `updateRuns(input: [UpdateRunInput]): UpdateRuns` ## Arguments **`input`**: `[UpdateRunInput]` ## Returns `UpdateRuns` **`runs`**: `[Run]` ## Examples ```graphql Mutation mutation UpdateRuns { updateRuns { runs { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Response { "data": { "updateRuns": { "runs": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # updateSession Source: https://docs.firstresonance.io/api-reference/mutations/updateSession **mutation** `updateSession(input: UpdateSessionInput!): UpdateSession` ## Arguments **`input`**: `UpdateSessionInput!` (required) ## Returns `UpdateSession` **`session`**: `Session` ## Examples ```graphql Mutation mutation UpdateSession($input: UpdateSessionInput!) { updateSession(input: $input) { session { Created LastSessionId Updated _etag checkIn checkOut } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateSession": { "session": { "Created": "value", "LastSessionId": "string", "Updated": "value", "_etag": "string", "checkIn": "value", "checkOut": "value" } } } } ``` # updateSnapshotExportJob Source: https://docs.firstresonance.io/api-reference/mutations/updateSnapshotExportJob **mutation** `updateSnapshotExportJob(input: UpdateSnapshotExportJobInput!): UpdateSnapshotExportJob` ## Arguments **`input`**: `UpdateSnapshotExportJobInput!` (required) ## Returns `UpdateSnapshotExportJob` **`snapshotExportJob`**: `SnapshotExportJob` ## Examples ```graphql Mutation mutation UpdateSnapshotExportJob($input: UpdateSnapshotExportJobInput!) { updateSnapshotExportJob(input: $input) { snapshotExportJob { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateSnapshotExportJob": { "snapshotExportJob": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateStep Source: https://docs.firstresonance.io/api-reference/mutations/updateStep Updates an existing step within a procedure. **mutation** `updateStep(input: UpdateStepInput!): UpdateStep` ## Arguments **`input`**: `UpdateStepInput!` (required) ## Returns `UpdateStep` **`step`**: `Step` ## Examples ```graphql Mutation mutation UpdateStep($input: UpdateStepInput!) { updateStep(input: $input) { step { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStep": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } } ``` # updateStepApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateStepApproval **mutation** `updateStepApproval(input: UpdateStepApprovalInput!): UpdateStepApproval` ## Arguments **`input`**: `UpdateStepApprovalInput!` (required) ## Returns `UpdateStepApproval` **`approval`**: `StepApproval` ## Examples ```graphql Mutation mutation UpdateStepApproval($input: UpdateStepApprovalInput!) { updateStepApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStepApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateStepApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateStepApprovalRequest **mutation** `updateStepApprovalRequest(input: UpdateStepApprovalRequestInput!): UpdateStepApprovalRequest` ## Arguments **`input`**: `UpdateStepApprovalRequestInput!` (required) ## Returns `UpdateStepApprovalRequest` **`approvalRequest`**: `StepApprovalRequest` ## Examples ```graphql Mutation mutation UpdateStepApprovalRequest($input: UpdateStepApprovalRequestInput!) { updateStepApprovalRequest(input: $input) { approvalRequest { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStepApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateStepApprovalRole Source: https://docs.firstresonance.io/api-reference/mutations/updateStepApprovalRole **mutation** `updateStepApprovalRole(input: UpdateStepApprovalRoleInput!): UpdateStepApprovalRole` ## Arguments **`input`**: `UpdateStepApprovalRoleInput!` (required) ## Returns `UpdateStepApprovalRole` **`approvalRole`**: `StepApprovalRole` ## Examples ```graphql Mutation mutation UpdateStepApprovalRole($input: UpdateStepApprovalRoleInput!) { updateStepApprovalRole(input: $input) { approvalRole { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "gateType": "RELEASED", "roleId": 1 } } ``` ```json Response { "data": { "updateStepApprovalRole": { "approvalRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateStepAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateStepAttribute Updates an attribute on a step. Attributes are custom metadata for a step. **mutation** `updateStepAttribute(input: UpdateStepAttributeInput!): UpdateStepAttribute` ## Arguments **`input`**: `UpdateStepAttributeInput!` (required) ## Returns `UpdateStepAttribute` **`stepAttribute`**: `StepAttribute` ## Examples ```graphql Mutation mutation UpdateStepAttribute($input: UpdateStepAttributeInput!) { updateStepAttribute(input: $input) { stepAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "stepId": 1 } } ``` ```json Response { "data": { "updateStepAttribute": { "stepAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateStepField Source: https://docs.firstresonance.io/api-reference/mutations/updateStepField Updates a field within a step. **mutation** `updateStepField(input: UpdateStepFieldInput!): UpdateStepField` ## Arguments **`input`**: `UpdateStepFieldInput!` (required) ## Returns `UpdateStepField` **`stepField`**: `StepField` ## Examples ```graphql Mutation mutation UpdateStepField($input: UpdateStepFieldInput!) { updateStepField(input: $input) { stepField { LastSessionId _ValidationsCount _created _etag _updated allowNotApplicable } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStepField": { "stepField": { "LastSessionId": "string", "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allowNotApplicable": true } } } } ``` # updateStepFieldValidation Source: https://docs.firstresonance.io/api-reference/mutations/updateStepFieldValidation **mutation** `updateStepFieldValidation(input: UpdateStepFieldValidationInput!): UpdateStepFieldValidation` ## Arguments **`input`**: `UpdateStepFieldValidationInput!` (required) ## Returns `UpdateStepFieldValidation` **`stepFieldValidation`**: `StepFieldValidation` ## Examples ```graphql Mutation mutation UpdateStepFieldValidation($input: UpdateStepFieldValidationInput!) { updateStepFieldValidation(input: $input) { stepFieldValidation { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStepFieldValidation": { "stepFieldValidation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateStepPartRequirement Source: https://docs.firstresonance.io/api-reference/mutations/updateStepPartRequirement Updates a part requirement for a step. This defines which parts are needed for the step. **mutation** `updateStepPartRequirement(input: UpdateStepPartRequirementInput!): UpdateStepPartRequirement` ## Arguments **`input`**: `UpdateStepPartRequirementInput!` (required) ## Returns `UpdateStepPartRequirement` **`stepPartRequirement`**: `StepPartRequirement` ## Examples ```graphql Mutation mutation UpdateStepPartRequirement($input: UpdateStepPartRequirementInput!) { updateStepPartRequirement(input: $input) { stepPartRequirement { Deleted LastSessionId _AssignedReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _ReferenceDesignatorsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": 1 } } ``` ```json Response { "data": { "updateStepPartRequirement": { "stepPartRequirement": { "Deleted": true, "LastSessionId": "string", "_AssignedReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_ReferenceDesignatorsCount": 1 } } } } ``` # updateStepRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/mutations/updateStepRoleBasedApproval **mutation** `updateStepRoleBasedApproval(input: UpdateStepRoleBasedApprovalInput!): UpdateStepRoleBasedApproval` ## Arguments **`input`**: `UpdateStepRoleBasedApprovalInput!` (required) ## Returns `UpdateStepRoleBasedApproval` **`approval`**: `StepRoleBasedApproval` ## Examples ```graphql Mutation mutation UpdateStepRoleBasedApproval($input: UpdateStepRoleBasedApprovalInput!) { updateStepRoleBasedApproval(input: $input) { approval { LastSessionId _RepliesCount _created _etag _updated comment } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStepRoleBasedApproval": { "approval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } } ``` # updateStepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/mutations/updateStepRoleBasedApprovalRequest **mutation** `updateStepRoleBasedApprovalRequest(input: UpdateStepRoleBasedApprovalRequestInput!): UpdateStepRoleBasedApprovalRequest` ## Arguments **`input`**: `UpdateStepRoleBasedApprovalRequestInput!` (required) ## Returns `UpdateStepRoleBasedApprovalRequest` **`approvalRequest`**: `StepRoleBasedApprovalRequest` ## Examples ```graphql Mutation mutation UpdateStepRoleBasedApprovalRequest($input: UpdateStepRoleBasedApprovalRequestInput!) { updateStepRoleBasedApprovalRequest(input: $input) { approvalRequest { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateStepRoleBasedApprovalRequest": { "approvalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } } ``` # updateSupplier Source: https://docs.firstresonance.io/api-reference/mutations/updateSupplier **mutation** `updateSupplier(input: UpdateSupplierInput!): UpdateSupplier` ## Arguments **`input`**: `UpdateSupplierInput!` (required) ## Returns `UpdateSupplier` **`supplier`**: `Supplier` ## Examples ```graphql Mutation mutation UpdateSupplier($input: UpdateSupplierInput!) { updateSupplier(input: $input) { supplier { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateSupplier": { "supplier": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } } ``` # updateSupplierAttribute Source: https://docs.firstresonance.io/api-reference/mutations/updateSupplierAttribute Updates an attribute on a supplier. **mutation** `updateSupplierAttribute(input: UpdateSupplierAttributeInput!): UpdateSupplierAttribute` ## Arguments **`input`**: `UpdateSupplierAttributeInput!` (required) ## Returns `UpdateSupplierAttribute` **`supplierAttribute`**: `SupplierAttribute` ## Examples ```graphql Mutation mutation UpdateSupplierAttribute($input: UpdateSupplierAttributeInput!) { updateSupplierAttribute(input: $input) { supplierAttribute { Created Etag LastSessionId Updated _IonValueCount _ValueCount } } } ``` ```json Variables { "input": { "etag": "string", "key": "string", "supplierId": 1 } } ``` ```json Response { "data": { "updateSupplierAttribute": { "supplierAttribute": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } } } } ``` # updateSupplierPart Source: https://docs.firstresonance.io/api-reference/mutations/updateSupplierPart **mutation** `updateSupplierPart(input: UpdateSupplierPartInput!): UpdateSupplierPart` ## Arguments **`input`**: `UpdateSupplierPartInput!` (required) ## Returns `UpdateSupplierPart` **`supplierPart`**: `SupplierPart` ## Examples ```graphql Mutation mutation UpdateSupplierPart($input: UpdateSupplierPartInput!) { updateSupplierPart(input: $input) { supplierPart { LastSessionId _PurchaseOrderLinesCount _created _etag _updated conversionFactor } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateSupplierPart": { "supplierPart": { "LastSessionId": "string", "_PurchaseOrderLinesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "conversionFactor": 1.5 } } } } ``` # updateTeam Source: https://docs.firstresonance.io/api-reference/mutations/updateTeam **mutation** `updateTeam(input: UpdateTeamInput!): UpdateTeam` ## Arguments **`input`**: `UpdateTeamInput!` (required) ## Returns `UpdateTeam` **`team`**: `Team` ## Examples ```graphql Mutation mutation UpdateTeam($input: UpdateTeamInput!) { updateTeam(input: $input) { team { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateTeam": { "team": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # updateUnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/mutations/updateUnitOfMeasurement **mutation** `updateUnitOfMeasurement(input: UpdateUnitOfMeasurementInput!): UpdateUnitOfMeasurement` ## Arguments **`input`**: `UpdateUnitOfMeasurementInput!` (required) ## Returns `UpdateUnitOfMeasurement` **`unitOfMeasurement`**: `UnitOfMeasurement` ## Examples ```graphql Mutation mutation UpdateUnitOfMeasurement($input: UpdateUnitOfMeasurementInput!) { updateUnitOfMeasurement(input: $input) { unitOfMeasurement { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateUnitOfMeasurement": { "unitOfMeasurement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateUser Source: https://docs.firstresonance.io/api-reference/mutations/updateUser **mutation** `updateUser(input: UpdateUserInput!): UpdateUser` ## Arguments **`input`**: `UpdateUserInput!` (required) ## Returns `UpdateUser` **`user`**: `User` ## Examples ```graphql Mutation mutation UpdateUser($input: UpdateUserInput!) { updateUser(input: $input) { user { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateUser": { "user": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # updateUserNotification Source: https://docs.firstresonance.io/api-reference/mutations/updateUserNotification **mutation** `updateUserNotification(input: UpdateUserNotificationInput!): UpdateUserNotification` ## Arguments **`input`**: `UpdateUserNotificationInput!` (required) ## Returns `UpdateUserNotification` **`userNotification`**: `UserNotification` ## Examples ```graphql Mutation mutation UpdateUserNotification($input: UpdateUserNotificationInput!) { updateUserNotification(input: $input) { userNotification { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateUserNotification": { "userNotification": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # updateWebhookHeader Source: https://docs.firstresonance.io/api-reference/mutations/updateWebhookHeader **mutation** `updateWebhookHeader(input: UpdateWebhookHeaderInput!): UpdateWebhookHeader` ## Arguments **`input`**: `UpdateWebhookHeaderInput!` (required) ## Returns `UpdateWebhookHeader` **`webhookHeader`**: `WebhookHeader` ## Examples ```graphql Mutation mutation UpdateWebhookHeader($input: UpdateWebhookHeaderInput!) { updateWebhookHeader(input: $input) { webhookHeader { LastSessionId _WebhookReceiversCount _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateWebhookHeader": { "webhookHeader": { "LastSessionId": "string", "_WebhookReceiversCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # updateWebhookReceiver Source: https://docs.firstresonance.io/api-reference/mutations/updateWebhookReceiver **mutation** `updateWebhookReceiver(input: UpdateWebhookReceiverInput!): UpdateWebhookReceiver` ## Arguments **`input`**: `UpdateWebhookReceiverInput!` (required) ## Returns `UpdateWebhookReceiver` **`webhookReceiver`**: `WebhookReceiver` ## Examples ```graphql Mutation mutation UpdateWebhookReceiver($input: UpdateWebhookReceiverInput!) { updateWebhookReceiver(input: $input) { webhookReceiver { LastSessionId _HeadersCount _SubscriptionsCount _created _etag _updated } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateWebhookReceiver": { "webhookReceiver": { "LastSessionId": "string", "_HeadersCount": 1, "_SubscriptionsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # updateWebhookSubscription Source: https://docs.firstresonance.io/api-reference/mutations/updateWebhookSubscription **mutation** `updateWebhookSubscription(input: UpdateWebhookSubscriptionInput!): UpdateWebhookSubscription` ## Arguments **`input`**: `UpdateWebhookSubscriptionInput!` (required) ## Returns `UpdateWebhookSubscription` **`webhookSubscription`**: `WebhookSubscription` ## Examples ```graphql Mutation mutation UpdateWebhookSubscription($input: UpdateWebhookSubscriptionInput!) { updateWebhookSubscription(input: $input) { webhookSubscription { LastSessionId _EventsCount _created _etag _updated action } } } ``` ```json Variables { "input": { "etag": "string", "id": "id" } } ``` ```json Response { "data": { "updateWebhookSubscription": { "webhookSubscription": { "LastSessionId": "string", "_EventsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "action": "CREATE" } } } } ``` # upsertUserDefinedMessage Source: https://docs.firstresonance.io/api-reference/mutations/upsertUserDefinedMessage Creates or updates an org-scoped user-defined message keyed by message_key. An empty message deletes the existing record. **mutation** `upsertUserDefinedMessage(input: UpsertUserDefinedMessageInput!): UpsertUserDefinedMessage` ## Arguments **`input`**: `UpsertUserDefinedMessageInput!` (required) ## Returns `UpsertUserDefinedMessage` **`userDefinedMessage`**: `UserDefinedMessage` ## Examples ```graphql Mutation mutation UpsertUserDefinedMessage($input: UpsertUserDefinedMessageInput!) { upsertUserDefinedMessage(input: $input) { userDefinedMessage { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } } ``` ```json Variables { "input": { "message": "string", "messageKey": "RUN_BANNER" } } ``` ```json Response { "data": { "upsertUserDefinedMessage": { "userDefinedMessage": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } } ``` # verifyOrganizationDomain Source: https://docs.firstresonance.io/api-reference/mutations/verifyOrganizationDomain Verifies ownership of a claimed domain via DNS TXT record lookup. **mutation** `verifyOrganizationDomain(etag: String!, id: ID!): VerifyOrganizationDomain` ## Arguments **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) ## Returns `VerifyOrganizationDomain` **`organizationDomain`**: `OrganizationDomain` ## Examples ```graphql Mutation mutation VerifyOrganizationDomain($etag: String!, $id: ID!) { verifyOrganizationDomain(etag: $etag, id: $id) { organizationDomain { LastSessionId _created _etag _updated auth0DomainId createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } } ``` ```json Variables { "etag": "string", "id": "id" } ``` ```json Response { "data": { "verifyOrganizationDomain": { "organizationDomain": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0DomainId": "string", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } } ``` # Overview Source: https://docs.firstresonance.io/api-reference/overview Set up access to the ION GraphQL API, then look up every query, mutation, and type it exposes. This reference lists every query, mutation, and type in the ION GraphQL API. It is generated from the API's schema, so it matches the API that ships. ## Set up access 1. Get a token. Use an [API key](/api/authentication/api-keys) for a machine-to-machine integration, or [OAuth 2.0](/api/authentication/oauth) for a user-facing application. 2. Send every request, with `POST`, to the API endpoint for your region. For each environment's endpoint, see [ION environments](/getting-started/ion-basics#ion-environments). 3. Authenticate each request with these headers: ``` Authorization: Bearer Content-Type: application/json ``` For a first request from start to finish, see [Getting started](/api/getting-started). To build against a non-production environment first, see [Sandbox](/api/sandbox). ## Use this reference * **Queries** read data. * **Mutations** create, update, and delete data. * **Types** define the fields each query returns and each mutation accepts. To run a query against your organization, use the [API playground](/api/playground). For guides and example requests, see the **API** section of the Documentation tab. # _entities Source: https://docs.firstresonance.io/api-reference/queries/_entities **query** `_entities(representations: [_Any!]!): [_Entity]!` ## Arguments **`representations`**: `[_Any!]!` (required) ## Returns `[_Entity]!` ## Examples ```graphql Query query _entities($representations: [_Any!]!) { _entities(representations: $representations) { __typename ... on ABomInstallation { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } } ``` ```json Variables { "representations": [ "value" ] } ``` ```json Response { "data": { "_entities": [ { "__typename": "ABomInstallation", "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } ] } } ``` # _service Source: https://docs.firstresonance.io/api-reference/queries/_service **query** `_service: _Service!` ## Returns `_Service!` **`sdl`**: `String` ## Examples ```graphql Query query _service { _service { sdl } } ``` ```json Response { "data": { "_service": { "sdl": "string" } } } ``` # abomInstallation Source: https://docs.firstresonance.io/api-reference/queries/abomInstallation Retrieves an item by its ID. **query** `abomInstallation(buildRequirementId: ID!, partInventoryId: ID!): ABomInstallation` ## Arguments **`buildRequirementId`**: `ID!` (required) --- **`partInventoryId`**: `ID!` (required) ## Returns `ABomInstallation` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` Return the build_requirement relationship. **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignator` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirementReferenceDesignatorId`**: `Int` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`partInventory`**: `PartInventory` Return the part_inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`quantityInstalledPerParentPartInventory`**: `Float!` Quantity installed per parent part inventory. --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepBuildRequirement`**: `RunStepBuildRequirement` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ABomInstallationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query AbomInstallation($buildRequirementId: ID!, $partInventoryId: ID!) { abomInstallation(buildRequirementId: $buildRequirementId, partInventoryId: $partInventoryId) { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } ``` ```json Variables { "buildRequirementId": "id", "partInventoryId": "id" } ``` ```json Response { "data": { "abomInstallation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } ``` # abomInstallations Source: https://docs.firstresonance.io/api-reference/queries/abomInstallations Retrieves a list of items. **query** `abomInstallations(after: String, before: String, distinctOn: [ABomInstallationSortEnum], filters: ABomInstallationsInputFilters, first: Int, last: Int, sort: [ABomInstallationSortEnum]): ABomInstallationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ABomInstallationSortEnum]` --- **`filters`**: `ABomInstallationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ABomInstallationSortEnum]` ## Returns `ABomInstallationsConnection` **`edges`**: `[ABomInstallationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query AbomInstallations { abomInstallations { edges { cursor node { LastSessionId _created _etag _updated buildRequirement { __typename } buildRequirementId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "abomInstallations": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "__typename": "BuildRequirement" }, "buildRequirementId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # aiTermsOfService Source: https://docs.firstresonance.io/api-reference/queries/aiTermsOfService The AI Terms of Service in force for this deployment's region, with the version an acceptance must submit. Served here so the displayed text and the recorded version share one source. **query** `aiTermsOfService: AiTermsOfService` ## Returns `AiTermsOfService` **`body`**: `String` The terms to display, as markdown. --- **`bodySha256`**: `String` Digest of the body served here. Submit it back with the acceptance to prove the text that was displayed is the text still in force. --- **`identifier`**: `String` The '-' value an acceptance must submit and that is recorded against it. --- **`variant`**: `String` Which terms govern this deployment: commercial or govcloud. Determined by the region, never by the caller. --- **`version`**: `String` This variant's version, bumped independently. ## Examples ```graphql Query query AiTermsOfService { aiTermsOfService { body bodySha256 identifier variant version } } ``` ```json Response { "data": { "aiTermsOfService": { "body": "string", "bodySha256": "string", "identifier": "string", "variant": "string", "version": "string" } } } ``` # aiTosAcceptances Source: https://docs.firstresonance.io/api-reference/queries/aiTosAcceptances This organization's AI Terms of Service acceptance history, newest first. Append-only: a version bump or a re-acceptance adds a row rather than replacing one. **query** `aiTosAcceptances: [AiTosAcceptance]` ## Returns `[AiTosAcceptance]` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`body`**: `String!` --- **`bodySha256`**: `String!` --- **`clientIpHash`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`identifier`**: `String` The '-' this acceptance covers. --- **`isCurrent`**: `Boolean` Whether this acceptance still satisfies the terms in force. False once the version is bumped, which re-gates AI until an admin accepts again. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`userAgent`**: `String` --- **`variant`**: `String!` --- **`version`**: `String!` ## Examples ```graphql Query query AiTosAcceptances { aiTosAcceptances { LastSessionId _created _etag _updated body bodySha256 } } ``` ```json Response { "data": { "aiTosAcceptances": [ { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "body": "string", "bodySha256": "string" } ] } } ``` # apiClientActivity Source: https://docs.firstresonance.io/api-reference/queries/apiClientActivity Actor-first audit view: actions taken by a given API client, newest first. The full audit footprint is returned (minus a few internal tables). **query** `apiClientActivity(after: String, apiClientId: Int!, before: String, first: Int, last: Int): ApiClientActivityConnection` ## Arguments **`after`**: `String` --- **`apiClientId`**: `Int!` (required) --- **`before`**: `String` --- **`first`**: `Int` --- **`last`**: `Int` ## Returns `ApiClientActivityConnection` **`edges`**: `[ApiClientActivityEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ApiClientActivity($apiClientId: Int!) { apiClientActivity(apiClientId: $apiClientId) { edges { cursor node { actionType changeSummary id label modelId owningUserId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Variables { "apiClientId": 1 } ``` ```json Response { "data": { "apiClientActivity": { "edges": [ { "cursor": "string", "node": { "actionType": "CHILD_ADDED", "changeSummary": "value", "id": "id", "label": "string", "modelId": 1, "owningUserId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # apiKeys Source: https://docs.firstresonance.io/api-reference/queries/apiKeys Retrieves a list of API keys. **query** `apiKeys(after: String, before: String, filters: APIKeyInputFilters, first: Int, last: Int): APIKeyConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`filters`**: `APIKeyInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` ## Returns `APIKeyConnection` **`edges`**: `[APIKeyEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. ## Examples ```graphql Query query ApiKeys { apiKeys { edges { cursor node { _created _etag _updated clientId clientSecret createdByApiClient { __typename } } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor } } } ``` ```json Response { "data": { "apiKeys": { "edges": [ { "cursor": "string", "node": { "_created": "value", "_etag": "string", "_updated": "value", "clientId": "string", "clientSecret": "string", "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string" } } } } ``` # approvalLevel Source: https://docs.firstresonance.io/api-reference/queries/approvalLevel Retrieves an item by its ID. **query** `approvalLevel(id: ID!): ApprovalLevel` ## Arguments **`id`**: `ID!` (required) ## Returns `ApprovalLevel` **`LastSessionId`**: `String` --- **`_CandidateUsersCount`**: `Int` Optimized count of candidateUsers. --- **`_PurchaseOrderApprovalLevelsCount`**: `Int` Optimized count of purchaseOrderApprovalLevels. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`candidateUsers`**: `[User]` --- **`costThreshold`**: `Int!` Return the minimum purchase order cost that triggers this approval level. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`isDeleted`**: `Boolean!` --- **`isTeamSelectedLater`**: `Boolean!` Whether the team should be selected now or when the PO goes into review. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`ordinalPosition`**: `Int!` Return the order of this approval level in the chain. --- **`prettyStr`**: `String` --- **`purchaseOrderApprovalLevels`**: `[PurchaseOrderApprovalLevel]` --- **`role`**: `Role` Return role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return team foreign key. --- **`team`**: `Team` Return team relationship. **Arguments:** - `filters`: `TeamsInputFilters` --- **`teamId`**: `Int` Return team foreign key. --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ApprovalLevelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ApprovalLevel($id: ID!) { approvalLevel(id: $id) { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "approvalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # approvalLevels Source: https://docs.firstresonance.io/api-reference/queries/approvalLevels Retrieves a list of items. **query** `approvalLevels(after: String, before: String, distinctOn: [ApprovalLevelSortEnum], filters: ApprovalLevelInputFilters, first: Int, last: Int, sort: [ApprovalLevelSortEnum]): ApprovalLevelsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ApprovalLevelSortEnum]` --- **`filters`**: `ApprovalLevelInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ApprovalLevelSortEnum]` ## Returns `ApprovalLevelsConnection` **`edges`**: `[ApprovalLevelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ApprovalLevels { approvalLevels { edges { cursor node { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "approvalLevels": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # barcodeLabel Source: https://docs.firstresonance.io/api-reference/queries/barcodeLabel Retrieves an item by its ID. **query** `barcodeLabel(id: ID!): BarcodeLabel` ## Arguments **`id`**: `ID!` (required) ## Returns `BarcodeLabel` **`LastSessionId`**: `String` --- **`_BarcodePrintRequestsCount`**: `Int` Optimized count of barcodePrintRequests. --- **`_LocationCount`**: `Int` --- **`_PartInventoryCount`**: `Int` --- **`_PartKitCount`**: `Int` --- **`_RunCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcode`**: `String` --- **`barcodePrintRequests`**: `[BarcodePrintRequest]` **Arguments:** - `filters`: `BarcodePrintRequestsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deactivated`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`iuid`**: `String!` --- **`labelPreview`**: `FileAttachment` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`labelPreviewId`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`qrCode`**: `String` --- **`subject`**: `BarcodeSubject` --- **`template`**: `BarcodeTemplate` **Arguments:** - `filters`: `BarcodeTemplatesInputFilters` --- **`templateId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodeLabelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query BarcodeLabel($id: ID!) { barcodeLabel(id: $id) { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "barcodeLabel": { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } } } ``` # barcodeLabels Source: https://docs.firstresonance.io/api-reference/queries/barcodeLabels Retrieves a list of items. **query** `barcodeLabels(after: String, before: String, distinctOn: [BarcodeLabelSortEnum], filters: BarcodeLabelsInputFilters, first: Int, last: Int, sort: [BarcodeLabelSortEnum]): BarcodeLabelsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BarcodeLabelSortEnum]` --- **`filters`**: `BarcodeLabelsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BarcodeLabelSortEnum]` ## Returns `BarcodeLabelsConnection` **`edges`**: `[BarcodeLabelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BarcodeLabels { barcodeLabels { edges { cursor node { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "barcodeLabels": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # barcodePattern Source: https://docs.firstresonance.io/api-reference/queries/barcodePattern Retrieves an item by its ID. **query** `barcodePattern(id: ID!): BarcodePattern` ## Arguments **`id`**: `ID!` (required) ## Returns `BarcodePattern` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodePatternJson`**: `JSONString` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityType`**: `Barcodeentitytypeenum` --- **`expression`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodePatternEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query BarcodePattern($id: ID!) { barcodePattern(id: $id) { LastSessionId _created _etag _updated barcodePatternJson createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "barcodePattern": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodePatternJson": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # barcodePatterns Source: https://docs.firstresonance.io/api-reference/queries/barcodePatterns Retrieves a list of items. **query** `barcodePatterns(after: String, before: String, distinctOn: [BarcodePatternSortEnum], filters: BarcodePatternsInputFilters, first: Int, last: Int, sort: [BarcodePatternSortEnum]): BarcodePatternsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BarcodePatternSortEnum]` --- **`filters`**: `BarcodePatternsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BarcodePatternSortEnum]` ## Returns `BarcodePatternsConnection` **`edges`**: `[BarcodePatternsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BarcodePatterns { barcodePatterns { edges { cursor node { LastSessionId _created _etag _updated barcodePatternJson createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "barcodePatterns": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodePatternJson": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # barcodePrintRequest Source: https://docs.firstresonance.io/api-reference/queries/barcodePrintRequest Retrieves an item by its ID. **query** `barcodePrintRequest(id: ID!): BarcodePrintRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `BarcodePrintRequest` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodeLabel`**: `BarcodeLabel` **Arguments:** - `filters`: `BarcodeLabelsInputFilters` --- **`barcodeLabelId`**: `Int` --- **`barcodeType`**: `Barcodeentitytypeenum!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityData`**: `JSONString` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`printerId`**: `Int` --- **`quantity`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodePrintRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query BarcodePrintRequest($id: ID!) { barcodePrintRequest(id: $id) { LastSessionId _created _etag _updated barcodeLabel { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } barcodeLabelId } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "barcodePrintRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabel": { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 }, "barcodeLabelId": 1 } } } ``` # barcodePrintRequests Source: https://docs.firstresonance.io/api-reference/queries/barcodePrintRequests Retrieves a list of items. **query** `barcodePrintRequests(after: String, before: String, distinctOn: [BarcodePrintRequestSortEnum], filters: BarcodePrintRequestsInputFilters, first: Int, last: Int, sort: [BarcodePrintRequestSortEnum]): BarcodePrintRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BarcodePrintRequestSortEnum]` --- **`filters`**: `BarcodePrintRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BarcodePrintRequestSortEnum]` ## Returns `BarcodePrintRequestsConnection` **`edges`**: `[BarcodePrintRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BarcodePrintRequests { barcodePrintRequests { edges { cursor node { LastSessionId _created _etag _updated barcodeLabel { __typename } barcodeLabelId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "barcodePrintRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabel": { "__typename": "BarcodeLabel" }, "barcodeLabelId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # barcodeScanRequest Source: https://docs.firstresonance.io/api-reference/queries/barcodeScanRequest Retrieves an item by its ID. **query** `barcodeScanRequest(id: ID!): BarcodeScanRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `BarcodeScanRequest` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodeJson`**: `JSONString` --- **`barcodeText`**: `String` --- **`barcodeType`**: `Barcodeentitytypeenum` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityIds`**: `[Int]` --- **`id`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodeScanRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query BarcodeScanRequest($id: ID!) { barcodeScanRequest(id: $id) { LastSessionId _created _etag _updated barcodeJson barcodeText } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "barcodeScanRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodeJson": "value", "barcodeText": "string" } } } ``` # barcodeScanRequests Source: https://docs.firstresonance.io/api-reference/queries/barcodeScanRequests Retrieves a list of items. **query** `barcodeScanRequests(after: String, before: String, distinctOn: [BarcodeScanRequestSortEnum], filters: BarcodeScanRequestsInputFilters, first: Int, last: Int, sort: [BarcodeScanRequestSortEnum]): BarcodeScanRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BarcodeScanRequestSortEnum]` --- **`filters`**: `BarcodeScanRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BarcodeScanRequestSortEnum]` ## Returns `BarcodeScanRequestsConnection` **`edges`**: `[BarcodeScanRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BarcodeScanRequests { barcodeScanRequests { edges { cursor node { LastSessionId _created _etag _updated barcodeJson barcodeText } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "barcodeScanRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "barcodeJson": "value", "barcodeText": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # barcodeTemplate Source: https://docs.firstresonance.io/api-reference/queries/barcodeTemplate Retrieves an item by its ID. **query** `barcodeTemplate(id: ID!): BarcodeTemplate` ## Arguments **`id`**: `ID!` (required) ## Returns `BarcodeTemplate` **`LastSessionId`**: `String` --- **`_BarcodeLabelsCount`**: `Int` Optimized count of barcodeLabels. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodeLabels`**: `[BarcodeLabel]` **Arguments:** - `filters`: `BarcodeLabelsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deactivated`**: `Boolean!` --- **`dpi`**: `Int!` --- **`entityType`**: `Barcodeentitytypeenum!` --- **`format`**: `Barcodeformatenum!` --- **`heightInches`**: `Float!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`template`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodeTemplateEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`widthInches`**: `Float!` ## Examples ```graphql Query query BarcodeTemplate($id: ID!) { barcodeTemplate(id: $id) { LastSessionId _BarcodeLabelsCount _created _etag _updated barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "barcodeTemplate": { "LastSessionId": "string", "_BarcodeLabelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ] } } } ``` # barcodeTemplateFieldOptions Source: https://docs.firstresonance.io/api-reference/queries/barcodeTemplateFieldOptions Retrieves the available field options for a barcode template based on its entity type. **query** `barcodeTemplateFieldOptions(templateEntityType: Barcodeentitytypeenum!): BarcodeTemplateFieldOptions` ## Arguments **`templateEntityType`**: `Barcodeentitytypeenum!` (required) ## Returns `BarcodeTemplateFieldOptions` **`options`**: `[String]` --- **`templateEntityType`**: `Barcodeentitytypeenum` ## Examples ```graphql Query query BarcodeTemplateFieldOptions($templateEntityType: Barcodeentitytypeenum!) { barcodeTemplateFieldOptions(templateEntityType: $templateEntityType) { options templateEntityType } } ``` ```json Variables { "templateEntityType": "LOCATIONS" } ``` ```json Response { "data": { "barcodeTemplateFieldOptions": { "options": [ "string" ], "templateEntityType": "LOCATIONS" } } } ``` # barcodeTemplates Source: https://docs.firstresonance.io/api-reference/queries/barcodeTemplates Retrieves a list of items. **query** `barcodeTemplates(after: String, before: String, distinctOn: [BarcodeTemplateSortEnum], filters: BarcodeTemplatesInputFilters, first: Int, last: Int, sort: [BarcodeTemplateSortEnum]): BarcodeTemplatesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BarcodeTemplateSortEnum]` --- **`filters`**: `BarcodeTemplatesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BarcodeTemplateSortEnum]` ## Returns `BarcodeTemplatesConnection` **`edges`**: `[BarcodeTemplatesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BarcodeTemplates { barcodeTemplates { edges { cursor node { LastSessionId _BarcodeLabelsCount _created _etag _updated barcodeLabels { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "barcodeTemplates": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_BarcodeLabelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "barcodeLabels": [ { "__typename": "BarcodeLabel" } ] } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # buildRequirement Source: https://docs.firstresonance.io/api-reference/queries/buildRequirement Retrieves an item by its ID. **query** `buildRequirement(id: ID!): BuildRequirement` ## Arguments **`id`**: `ID!` (required) ## Returns `BuildRequirement` **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AcceptablePartsCount`**: `Int` Optimized count of acceptableParts. --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_BuildRequirementSubstitutesCount`**: `Int` Optimized count of buildRequirementSubstitutes. --- **`_InstalledPartInventoriesCount`**: `Int` Optimized count of installedPartInventories. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_RunStepBuildRequirementsCount`**: `Int` Optimized count of runStepBuildRequirements. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `Int!` --- **`acceptablePartIds`**: `[Int]` Acceptable parts for this build requirement. --- **`acceptableParts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirementSubstitutes`**: `[BuildRequirementSubstitute]` **Arguments:** - `filters`: `BuildRequirementSubstitutesInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`fixedQuantityPerBuildRequirement`**: `Float` > Deprecated: Deprecated. Use quantityPerParentPartInventory instead. --- **`id`**: `Int!` --- **`installedPartInventories`**: `[PartInventory]` Part inventories installed on this build requirement. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`madeOnAssembly`**: `Boolean!` --- **`originMbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`originMbomItemId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`percentInstalled`**: `Int` Percent of the build requirement that is installed. Does not exceed 100% even when parts are over-installed. --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`quantityPerParentPartInventory`**: `Float!` This quantity multiplied by the parent part inventory's quantity is used in the calculation of the BuildRequirement's quantity. --- **`runStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BuildRequirementEventFilter` --- **`totalInstalledQuantity`**: `Float` --- **`totalParentPartInventoriesQuantity`**: `Float` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query BuildRequirement($id: ID!) { buildRequirement(id: $id) { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 } } } ``` # buildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/queries/buildRequirementReferenceDesignator Retrieves an item by its ID. **query** `buildRequirementReferenceDesignator(id: ID!): BuildRequirementReferenceDesignator` ## Arguments **`id`**: `ID!` (required) ## Returns `BuildRequirementReferenceDesignator` **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_InstalledPartInventoriesCount`**: `Int` Optimized count of installedPartInventories. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`assignedQuantity`**: `Int` The number of times this reference designator should be installed. A reference designator may be installed one time per qty of a multi-quantity producing RUN (e.g. for a run building 10 qty of part X), a reference designator may be installed 10 times). --- **`assignedRunStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`installedPartInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`installedQuantity`**: `Int` The number of times this reference designator has been installed. A reference designator may be installed one time per qty of a multi-quantity producing RUN (e.g. for a run building 10 qty of part X), a reference designator may be installed 10 times). --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`originMbomItemReferenceDesignator`**: `MBomItemReferenceDesignator` **Arguments:** - `filters`: `MBomItemReferenceDesignatorsInputFilters` --- **`originMbomItemReferenceDesignatorId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String!` ## Examples ```graphql Query query BuildRequirementReferenceDesignator($id: ID!) { buildRequirementReferenceDesignator(id: $id) { LastSessionId _AbomInstallationsCount _InstalledPartInventoriesCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "buildRequirementReferenceDesignator": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_InstalledPartInventoriesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # buildRequirementReferenceDesignators Source: https://docs.firstresonance.io/api-reference/queries/buildRequirementReferenceDesignators Retrieves a list of items. **query** `buildRequirementReferenceDesignators(after: String, before: String, distinctOn: [BuildRequirementReferenceDesignatorSortEnum], filters: BuildRequirementReferenceDesignatorsInputFilters, first: Int, last: Int, sort: [BuildRequirementReferenceDesignatorSortEnum]): BuildRequirementReferenceDesignatorsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BuildRequirementReferenceDesignatorSortEnum]` --- **`filters`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BuildRequirementReferenceDesignatorSortEnum]` ## Returns `BuildRequirementReferenceDesignatorsConnection` **`edges`**: `[BuildRequirementReferenceDesignatorsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BuildRequirementReferenceDesignators { buildRequirementReferenceDesignators { edges { cursor node { LastSessionId _AbomInstallationsCount _InstalledPartInventoriesCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "buildRequirementReferenceDesignators": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_InstalledPartInventoriesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # buildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/queries/buildRequirementSubstitute Retrieves an item by its ID. **query** `buildRequirementSubstitute(id: ID!): BuildRequirementSubstitute` ## Arguments **`id`**: `ID!` (required) ## Returns `BuildRequirementSubstitute` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`originMbomSubstitute`**: `MBomSubstitute` **Arguments:** - `filters`: `MBomSubstituteInputFilters` --- **`originMbomSubstituteId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BuildRequirementSubstituteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query BuildRequirementSubstitute($id: ID!) { buildRequirementSubstitute(id: $id) { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "buildRequirementSubstitute": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } ``` # buildRequirementSubstitutes Source: https://docs.firstresonance.io/api-reference/queries/buildRequirementSubstitutes Retrieves a list of items. **query** `buildRequirementSubstitutes(after: String, before: String, distinctOn: [BuildRequirementSubstituteSortEnum], filters: BuildRequirementSubstitutesInputFilters, first: Int, last: Int, sort: [BuildRequirementSubstituteSortEnum]): BuildRequirementSubstitutesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BuildRequirementSubstituteSortEnum]` --- **`filters`**: `BuildRequirementSubstitutesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BuildRequirementSubstituteSortEnum]` ## Returns `BuildRequirementSubstitutesConnection` **`edges`**: `[BuildRequirementSubstitutesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BuildRequirementSubstitutes { buildRequirementSubstitutes { edges { cursor node { LastSessionId _created _etag _updated buildRequirement { __typename } buildRequirementId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "buildRequirementSubstitutes": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "__typename": "BuildRequirement" }, "buildRequirementId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # buildRequirements Source: https://docs.firstresonance.io/api-reference/queries/buildRequirements Retrieves a list of items. **query** `buildRequirements(after: String, before: String, distinctOn: [BuildRequirementSortEnum], filters: BuildRequirementsInputFilters, first: Int, last: Int, sort: [BuildRequirementSortEnum]): BuildRequirementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[BuildRequirementSortEnum]` --- **`filters`**: `BuildRequirementsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[BuildRequirementSortEnum]` ## Returns `BuildRequirementsConnection` **`edges`**: `[BuildRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query BuildRequirements { buildRequirements { edges { cursor node { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "buildRequirements": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # changeOrder Source: https://docs.firstresonance.io/api-reference/queries/changeOrder Retrieves an item by its ID. **query** `changeOrder(id: ID!): ChangeOrder` ## Arguments **`id`**: `ID!` (required) ## Returns `ChangeOrder` **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[ChangeOrderApprovalRequest]` **Arguments:** - `filters`: `ChangeOrderApprovalRequestsInputFilters` --- **`approvals`**: `[ChangeOrderApproval]` **Arguments:** - `filters`: `ChangeOrderApprovalsInputFilters` --- **`approvedAt`**: `DateTime` --- **`changeOrderType`**: `Changeordertypeenum!` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `Int!` --- **`labels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`lineCount`**: `Int` --- **`prettyStr`**: `String` --- **`status`**: `Changeorderstatusenum!` --- **`targetEntity`**: `Entity` **Arguments:** - `filters`: `EntitysInputFilters` --- **`targetEntityId`**: `Float!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ChangeOrder($id: ID!) { changeOrder(id: $id) { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } ``` # changeOrderApproval Source: https://docs.firstresonance.io/api-reference/queries/changeOrderApproval Retrieves an item by its ID. **query** `changeOrderApproval(id: ID!): ChangeOrderApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `ChangeOrderApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`changeOrder`**: `ChangeOrder` **Arguments:** - `filters`: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `Int!` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Changeorderapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `ChangeOrderApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[ChangeOrderApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ChangeOrderApproval($id: ID!) { changeOrderApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated changeOrder { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "changeOrderApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "changeOrder": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } } } ``` # changeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/changeOrderApprovalRequest Retrieves an item by its ID. **query** `changeOrderApprovalRequest(id: ID!): ChangeOrderApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `ChangeOrderApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`changeOrder`**: `ChangeOrder` **Arguments:** - `filters`: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Changeorderapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ChangeOrderApprovalRequest($id: ID!) { changeOrderApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "changeOrderApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # changeOrderApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/changeOrderApprovalRequests Retrieves a list of items. **query** `changeOrderApprovalRequests(after: String, before: String, distinctOn: [ChangeOrderApprovalRequestSortEnum], filters: ChangeOrderApprovalRequestsInputFilters, first: Int, last: Int, sort: [ChangeOrderApprovalRequestSortEnum]): ChangeOrderApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ChangeOrderApprovalRequestSortEnum]` --- **`filters`**: `ChangeOrderApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ChangeOrderApprovalRequestSortEnum]` ## Returns `ChangeOrderApprovalRequestsConnection` **`edges`**: `[ChangeOrderApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ChangeOrderApprovalRequests { changeOrderApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "changeOrderApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # changeOrderApprovalRoles Source: https://docs.firstresonance.io/api-reference/queries/changeOrderApprovalRoles Retrieves a list of items. **query** `changeOrderApprovalRoles(after: String, before: String, distinctOn: [ChangeOrderApprovalRoleSortEnum], filters: ChangeOrderApprovalRolesInputFilters, first: Int, last: Int, sort: [ChangeOrderApprovalRoleSortEnum]): ChangeOrderApprovalRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ChangeOrderApprovalRoleSortEnum]` --- **`filters`**: `ChangeOrderApprovalRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ChangeOrderApprovalRoleSortEnum]` ## Returns `ChangeOrderApprovalRolesConnection` **`edges`**: `[ChangeOrderApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ChangeOrderApprovalRoles { changeOrderApprovalRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "changeOrderApprovalRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # changeOrderApprovals Source: https://docs.firstresonance.io/api-reference/queries/changeOrderApprovals Retrieves a list of items. **query** `changeOrderApprovals(after: String, before: String, distinctOn: [ChangeOrderApprovalSortEnum], filters: ChangeOrderApprovalsInputFilters, first: Int, last: Int, sort: [ChangeOrderApprovalSortEnum]): ChangeOrderApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ChangeOrderApprovalSortEnum]` --- **`filters`**: `ChangeOrderApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ChangeOrderApprovalSortEnum]` ## Returns `ChangeOrderApprovalsConnection` **`edges`**: `[ChangeOrderApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ChangeOrderApprovals { changeOrderApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated changeOrder { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "changeOrderApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "changeOrder": { "__typename": "ChangeOrder" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # changeOrders Source: https://docs.firstresonance.io/api-reference/queries/changeOrders Retrieves a list of items. **query** `changeOrders(after: String, before: String, distinctOn: [ChangeOrderSortEnum], filters: ChangeOrdersInputFilters, first: Int, last: Int, sort: [ChangeOrderSortEnum]): ChangeOrdersConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ChangeOrderSortEnum]` --- **`filters`**: `ChangeOrdersInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ChangeOrderSortEnum]` ## Returns `ChangeOrdersConnection` **`edges`**: `[ChangeOrdersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ChangeOrders { changeOrders { edges { cursor node { LastSessionId _ApprovalRequestsCount _ApprovalsCount _CommentsCount _LabelsCount _created } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "changeOrders": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_CommentsCount": 1, "_LabelsCount": 1, "_created": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # chargeAccount Source: https://docs.firstresonance.io/api-reference/queries/chargeAccount Retrieves an item by its ID. **query** `chargeAccount(id: ID!): ChargeAccount` ## Arguments **`id`**: `ID!` (required) ## Returns `ChargeAccount` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`archived`**: `Boolean!` --- **`code`**: `String!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ChargeAccount($id: ID!) { chargeAccount(id: $id) { LastSessionId _created _etag _updated archived code } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "chargeAccount": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } } ``` # chargeAccounts Source: https://docs.firstresonance.io/api-reference/queries/chargeAccounts Retrieves a list of items. **query** `chargeAccounts(after: String, before: String, distinctOn: [ChargeAccountSortEnum], filters: ChargeAccountsInputFilters, first: Int, last: Int, sort: [ChargeAccountSortEnum]): ChargeAccountsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ChargeAccountSortEnum]` --- **`filters`**: `ChargeAccountsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ChargeAccountSortEnum]` ## Returns `ChargeAccountsConnection` **`edges`**: `[ChargeAccountsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ChargeAccounts { chargeAccounts { edges { cursor node { LastSessionId _created _etag _updated archived code } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "chargeAccounts": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # comment Source: https://docs.firstresonance.io/api-reference/queries/comment Retrieves an item by its ID. **query** `comment(id: ID!): Comment` ## Arguments **`id`**: `ID!` (required) ## Returns `Comment` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_RunCount`**: `Int` --- **`_RunStepCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[Comment]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchAdoptedSiblings`**: `[Comment]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[Comment]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `Boolean` --- **`content`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `Comment` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`procedureFeedback`**: `Boolean!` --- **`replies`**: `[Comment]` --- **`resolved`**: `Boolean!` --- **`run`**: `Run` --- **`runStep`**: `RunStep` --- **`slateContent`**: `SlateContent` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `CommentEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Comment($id: ID!) { comment(id: $id) { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "comment": { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } } } ``` # comments Source: https://docs.firstresonance.io/api-reference/queries/comments Retrieves a list of items. **query** `comments(after: String, before: String, distinctOn: [CommentSortEnum], filters: CommentsInputFilters, first: Int, last: Int, sort: [CommentSortEnum]): CommentsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[CommentSortEnum]` --- **`filters`**: `CommentsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[CommentSortEnum]` ## Returns `CommentsConnection` **`edges`**: `[CommentsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Comments { comments { edges { cursor node { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "comments": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # contact Source: https://docs.firstresonance.io/api-reference/queries/contact Retrieves an item by its ID. **query** `contact(id: ID!): Contact` ## Arguments **`id`**: `ID!` (required) ## Returns `Contact` **`LastSessionId`**: `String` --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`email`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` **Arguments:** - `filters`: `LocationsInputFilters` --- **`name`**: `String!` --- **`phoneNumber`**: `String` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ContactEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Contact($id: ID!) { contact(id: $id) { LastSessionId _LocationsCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "contact": { "LastSessionId": "string", "_LocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # contacts Source: https://docs.firstresonance.io/api-reference/queries/contacts Retrieves a list of items. **query** `contacts(after: String, before: String, distinctOn: [ContactSortEnum], filters: ContactsInputFilters, first: Int, last: Int, sort: [ContactSortEnum]): ContactsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ContactSortEnum]` --- **`filters`**: `ContactsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ContactSortEnum]` ## Returns `ContactsConnection` **`edges`**: `[ContactsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Contacts { contacts { edges { cursor node { LastSessionId _LocationsCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "contacts": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_LocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # currencies Source: https://docs.firstresonance.io/api-reference/queries/currencies Retrieves a list of items. **query** `currencies(after: String, before: String, distinctOn: [CurrencySortEnum], filters: CurrenciesInputFilters, first: Int, last: Int, sort: [CurrencySortEnum]): CurrenciesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[CurrencySortEnum]` --- **`filters`**: `CurrenciesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[CurrencySortEnum]` ## Returns `CurrenciesConnection` **`edges`**: `[CurrenciesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Currencies { currencies { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "currencies": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # currency Source: https://docs.firstresonance.io/api-reference/queries/currency Retrieves an item by its ID. **query** `currency(id: ID!): Currency` ## Arguments **`id`**: `ID!` (required) ## Returns `Currency` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id of creator related to Enum. Returns: int of id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `CurrencyEventFilter` --- **`type`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id of updater related to Enum. Returns: int of id ## Examples ```graphql Query query Currency($id: ID!) { currency(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "currency": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # customerOrganizations Source: https://docs.firstresonance.io/api-reference/queries/customerOrganizations (FR admin only) Lists every customer organization across tenant schemas with Auth0 link status. **query** `customerOrganizations: [CustomerOrganizationSummary]` ## Returns `[CustomerOrganizationSummary]` **`auth0OrgId`**: `String` --- **`created`**: `DateTime` --- **`domain`**: `String` --- **`id`**: `Int` --- **`name`**: `String` --- **`schemaName`**: `String` ## Examples ```graphql Query query CustomerOrganizations { customerOrganizations { auth0OrgId created domain id name schemaName } } ``` ```json Response { "data": { "customerOrganizations": [ { "auth0OrgId": "string", "created": "value", "domain": "string", "id": 1, "name": "string", "schemaName": "string" } ] } } ``` # datagridColumn Source: https://docs.firstresonance.io/api-reference/queries/datagridColumn Retrieves an item by its ID. **query** `datagridColumn(id: ID!): DatagridColumn` ## Arguments **`id`**: `ID!` (required) ## Returns `DatagridColumn` **`LastSessionId`**: `String` --- **`Settable`**: `Boolean!` --- **`_ValuesCount`**: `Int` Optimized count of values. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[DatagridColumn]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`allowedIonType`**: `datagridiontypeentitytypeenum` --- **`batchAdoptedSiblings`**: `[DatagridColumn]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[DatagridColumn]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`header`**: `String` --- **`id`**: `Int!` --- **`index`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`options`**: `[String]` --- **`parent`**: `String` --- **`prettyStr`**: `String` --- **`readOnly`**: `Boolean` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`settable`**: `Boolean` --- **`signoffRole`**: `Role` Get Role for signoff. Returns: relationship object **Arguments:** - `filters`: `RolesInputFilters` --- **`signoffRoleId`**: `Int` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `DatagridColumnEventFilter` --- **`type`**: `datagrid_typefieldtypes` --- **`unit`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`values`**: `[DatagridValue]` **Arguments:** - `filters`: `DatagridValuesInputFilters` ## Examples ```graphql Query query DatagridColumn($id: ID!) { datagridColumn(id: $id) { LastSessionId Settable _ValuesCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "datagridColumn": { "LastSessionId": "string", "Settable": true, "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # datagridColumns Source: https://docs.firstresonance.io/api-reference/queries/datagridColumns Retrieves a list of items. **query** `datagridColumns(after: String, before: String, distinctOn: [DatagridColumnSortEnum], filters: DatagridColumnsInputFilters, first: Int, last: Int, sort: [DatagridColumnSortEnum]): DatagridColumnsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[DatagridColumnSortEnum]` --- **`filters`**: `DatagridColumnsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[DatagridColumnSortEnum]` ## Returns `DatagridColumnsConnection` **`edges`**: `[DatagridColumnsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query DatagridColumns { datagridColumns { edges { cursor node { LastSessionId Settable _ValuesCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "datagridColumns": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "Settable": true, "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # datagridRow Source: https://docs.firstresonance.io/api-reference/queries/datagridRow Retrieves an item by its ID. **query** `datagridRow(id: ID!): DatagridRow` ## Arguments **`id`**: `ID!` (required) ## Returns `DatagridRow` **`LastSessionId`**: `String` --- **`_ValuesCount`**: `Int` Optimized count of values. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[DatagridRow]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`allowNotApplicable`**: `Boolean!` --- **`batchAdoptedSiblings`**: `[DatagridRow]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[DatagridRow]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `String` --- **`complete`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`id`**: `Int!` --- **`index`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `String` --- **`prettyStr`**: `String` --- **`required`**: `Boolean!` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `DatagridRowEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`values`**: `[DatagridValue]` **Arguments:** - `filters`: `DatagridValuesInputFilters` ## Examples ```graphql Query query DatagridRow($id: ID!) { datagridRow(id: $id) { LastSessionId _ValuesCount _created _etag _updated allBatchedSiblings { __typename } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "datagridRow": { "LastSessionId": "string", "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "DatagridRow" } ] } } } ``` # datagridRows Source: https://docs.firstresonance.io/api-reference/queries/datagridRows Retrieves a list of items. **query** `datagridRows(after: String, before: String, distinctOn: [DatagridRowSortEnum], filters: DatagridRowsInputFilters, first: Int, last: Int, sort: [DatagridRowSortEnum]): DatagridRowsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[DatagridRowSortEnum]` --- **`filters`**: `DatagridRowsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[DatagridRowSortEnum]` ## Returns `DatagridRowsConnection` **`edges`**: `[DatagridRowsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query DatagridRows { datagridRows { edges { cursor node { LastSessionId _ValuesCount _created _etag _updated allBatchedSiblings { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "datagridRows": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_ValuesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "DatagridRow" } ] } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # datagridValue Source: https://docs.firstresonance.io/api-reference/queries/datagridValue Retrieves an item by its ID. **query** `datagridValue(columnId: ID!, rowId: ID!): DatagridValue` ## Arguments **`columnId`**: `ID!` (required) --- **`rowId`**: `ID!` (required) ## Returns `DatagridValue` **`BooleanValue`**: `Boolean` --- **`DatetimeValue`**: `DateTime` --- **`LastSessionId`**: `String` --- **`MultiselectValues`**: `[String]` --- **`NumberValue`**: `Float` --- **`SelectValue`**: `String` --- **`StringValue`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[DatagridValue]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`batchAdoptedSiblings`**: `[DatagridValue]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[DatagridValue]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `String` --- **`column`**: `DatagridColumn` **Arguments:** - `filters`: `DatagridColumnsInputFilters` --- **`columnId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `ID` --- **`ionValue`**: `IonType` --- **`notApplicable`**: `Boolean!` --- **`partInventory`**: `PartInventory` Return part inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` Return part inventory foreign key relation. --- **`prettyStr`**: `String` --- **`row`**: `DatagridRow` **Arguments:** - `filters`: `DatagridRowsInputFilters` --- **`rowId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `DatagridValueEventFilter` --- **`type`**: `datagrid_typefieldtypes` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` ## Examples ```graphql Query query DatagridValue($columnId: ID!, $rowId: ID!) { datagridValue(columnId: $columnId, rowId: $rowId) { BooleanValue DatetimeValue LastSessionId MultiselectValues NumberValue SelectValue } } ``` ```json Variables { "columnId": "id", "rowId": "id" } ``` ```json Response { "data": { "datagridValue": { "BooleanValue": true, "DatetimeValue": "value", "LastSessionId": "string", "MultiselectValues": [ "string" ], "NumberValue": 1.5, "SelectValue": "string" } } } ``` # datagridValues Source: https://docs.firstresonance.io/api-reference/queries/datagridValues Retrieves a list of items. **query** `datagridValues(after: String, before: String, distinctOn: [DatagridValueSortEnum], filters: DatagridValuesInputFilters, first: Int, last: Int, sort: [DatagridValueSortEnum]): DatagridValuesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[DatagridValueSortEnum]` --- **`filters`**: `DatagridValuesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[DatagridValueSortEnum]` ## Returns `DatagridValuesConnection` **`edges`**: `[DatagridValuesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query DatagridValues { datagridValues { edges { cursor node { BooleanValue DatetimeValue LastSessionId MultiselectValues NumberValue SelectValue } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "datagridValues": { "edges": [ { "cursor": "string", "node": { "BooleanValue": true, "DatetimeValue": "value", "LastSessionId": "string", "MultiselectValues": [ "string" ], "NumberValue": 1.5, "SelectValue": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # demandGaps Source: https://docs.firstresonance.io/api-reference/queries/demandGaps Experimental API, subject to change. Exposes the gap between inventory supply and build requirement demand. **query** `demandGaps(after: String, before: String, first: Int, input: DemandGapsInput, last: Int): DemandGapConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`first`**: `Int` --- **`input`**: `DemandGapsInput` --- **`last`**: `Int` ## Returns `DemandGapConnection` **`edges`**: `[DemandGapEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. ## Examples ```graphql Query query DemandGaps { demandGaps { edges { cursor node { buildRequirementDemand id part { __typename } supply } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor } } } ``` ```json Response { "data": { "demandGaps": { "edges": [ { "cursor": "string", "node": { "buildRequirementDemand": 1.5, "id": "id", "part": { "__typename": "Part" }, "supply": 1.5 } } ], "pageInfo": { "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string" } } } } ``` # embeddedWorkflowBuilder Source: https://docs.firstresonance.io/api-reference/queries/embeddedWorkflowBuilder Retrieves information about the embedded workflow builder. **query** `embeddedWorkflowBuilder: EmbeddedWorkflowBuilder` ## Returns `EmbeddedWorkflowBuilder` **`hasAccess`**: `Boolean` ## Examples ```graphql Query query EmbeddedWorkflowBuilder { embeddedWorkflowBuilder { hasAccess } } ``` ```json Response { "data": { "embeddedWorkflowBuilder": { "hasAccess": true } } } ``` # entitiesRequirement Source: https://docs.firstresonance.io/api-reference/queries/entitiesRequirement Retrieves an item by its ID. **query** `entitiesRequirement(entityId: ID!, requirementId: ID!): EntitiesRequirement` ## Arguments **`entityId`**: `ID!` (required) --- **`requirementId`**: `ID!` (required) ## Returns `EntitiesRequirement` **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`requirement`**: `Requirement` **Arguments:** - `filters`: `RequirementsInputFilters` --- **`requirementId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `EntitiesRequirementEventFilter` ## Examples ```graphql Query query EntitiesRequirement($entityId: ID!, $requirementId: ID!) { entitiesRequirement(entityId: $entityId, requirementId: $requirementId) { _created _etag _updated entity { Updated assets { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } comments { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } fileAttachments { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } id } entityId id } } ``` ```json Variables { "entityId": "id", "requirementId": "id" } ``` ```json Response { "data": { "entitiesRequirement": { "_created": "value", "_etag": "string", "_updated": "value", "entity": { "Updated": "value", "assets": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ], "comments": [ { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } ], "fileAttachments": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "id": 1.5 }, "entityId": 1, "id": "id" } } } ``` # entitiesRequirements Source: https://docs.firstresonance.io/api-reference/queries/entitiesRequirements Retrieves a list of items. **query** `entitiesRequirements(after: String, before: String, distinctOn: [EntitiesRequirementSortEnum], filters: EntitiesRequirementsInputFilters, first: Int, last: Int, sort: [EntitiesRequirementSortEnum]): EntitiesRequirementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[EntitiesRequirementSortEnum]` --- **`filters`**: `EntitiesRequirementsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[EntitiesRequirementSortEnum]` ## Returns `EntitiesRequirementsConnection` **`edges`**: `[EntitiesRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query EntitiesRequirements { entitiesRequirements { edges { cursor node { _created _etag _updated entity { __typename } entityId id } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "entitiesRequirements": { "edges": [ { "cursor": "string", "node": { "_created": "value", "_etag": "string", "_updated": "value", "entity": { "__typename": "Entity" }, "entityId": 1, "id": "id" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # fieldHistories Source: https://docs.firstresonance.io/api-reference/queries/fieldHistories Retrieves a list of items. **query** `fieldHistories(after: String, before: String, distinctOn: [FieldHistorySortEnum], filters: FieldHistoriesInputFilters, first: Int, last: Int, sort: [FieldHistorySortEnum]): FieldHistoriesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FieldHistorySortEnum]` --- **`filters`**: `FieldHistoriesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FieldHistorySortEnum]` ## Returns `FieldHistoriesConnection` **`edges`**: `[FieldHistoriesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FieldHistories { fieldHistories { edges { cursor node { fieldName id modelId modelType tableName timestamp } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "fieldHistories": { "edges": [ { "cursor": "string", "node": { "fieldName": "string", "id": "string", "modelId": 1.5, "modelType": "string", "tableName": "string", "timestamp": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # fields Source: https://docs.firstresonance.io/api-reference/queries/fields Retrieves a list of items. **query** `fields(after: String, before: String, distinctOn: [StepFieldSortEnum], filters: FieldsInputFilters, first: Int, last: Int, sort: [StepFieldSortEnum]): FieldsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepFieldSortEnum]` --- **`filters`**: `FieldsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepFieldSortEnum]` ## Returns `FieldsConnection` **`edges`**: `[FieldsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Fields { fields { edges { cursor node { LastSessionId _ValidationsCount _created _etag _updated allowNotApplicable } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "fields": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allowNotApplicable": true } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # fileAttachment Source: https://docs.firstresonance.io/api-reference/queries/fileAttachment Retrieves an item by its ID. **query** `fileAttachment(id: ID!): FileAttachment` ## Arguments **`id`**: `ID!` (required) ## Returns `FileAttachment` **`LastSessionId`**: `String` --- **`_AssetEntitiesCount`**: `Int` Optimized count of assetEntities. --- **`_FileAttachmentEntitiesCount`**: `Int` Optimized count of fileAttachmentEntities. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assetEntities`**: `[Entity]` **Arguments:** - `filters`: `EntitysInputFilters` --- **`contentType`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`downloadUrl`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`file`**: `String` --- **`fileAttachmentEntities`**: `[Entity]` **Arguments:** - `filters`: `EntitysInputFilters` --- **`fileLocation`**: `String` --- **`filename`**: `String` --- **`id`**: `Int!` --- **`integrationFetchUrl`**: `String` --- **`integrationId`**: `String` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`provider`**: `Filestorageproviderenum!` --- **`runStepField`**: `[RunStepField]` **Arguments:** - `filters`: `RunStepFieldInputFilters` --- **`s3Bucket`**: `String` Deprecated field in favor of the column 'fileLocation'. --- **`s3Key`**: `String` Deprecated field in favor of the column 'file'. --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FileAttachmentEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`url`**: `String` To prevent confusion between uploadUrl and downloadUrl, renaming from url to downloadUrl. > Deprecated: Deprecated in favor of more specific downloadUrl. ## Examples ```graphql Query query FileAttachment($id: ID!) { fileAttachment(id: $id) { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "fileAttachment": { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # fileAttachments Source: https://docs.firstresonance.io/api-reference/queries/fileAttachments Retrieves a list of items. **query** `fileAttachments(after: String, before: String, distinctOn: [FileAttachmentSortEnum], filters: FileAttachmentsInputFilters, first: Int, last: Int, sort: [FileAttachmentSortEnum]): FileAttachmentsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FileAttachmentSortEnum]` --- **`filters`**: `FileAttachmentsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FileAttachmentSortEnum]` ## Returns `FileAttachmentsConnection` **`edges`**: `[FileAttachmentsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FileAttachments { fileAttachments { edges { cursor node { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "fileAttachments": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherAction Source: https://docs.firstresonance.io/api-reference/queries/furtherAction Retrieves an item by its ID. **query** `furtherAction(id: ID!): FurtherAction` ## Arguments **`id`**: `ID!` (required) ## Returns `FurtherAction` **`Attributes`**: `[FurtherActionAttribute]` **Arguments:** - `filters`: `FurtherActionAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartsCount`**: `Int` Optimized count of parts. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`analysisNotes`**: `SlateContent` --- **`approvalRequests`**: `[FurtherActionApprovalRequest]` **Arguments:** - `filters`: `FurtherActionApprovalRequestsInputFilters` --- **`approvals`**: `[FurtherActionApproval]` **Arguments:** - `filters`: `FurtherActionApprovalsInputFilters` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[FurtherActionAttributedPart]` **Arguments:** - `filters`: `FurtherActionAttributedPartsInputFilters` --- **`attributedUsers`**: `[FurtherActionAttributedUser]` **Arguments:** - `filters`: `FurtherActionAttributedUsersInputFilters` --- **`attributes`**: `[FurtherActionAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`estimatedCompletionDate`**: `DateTime` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`prettyStr`**: `String` --- **`problemStatement`**: `SlateContent` --- **`resolution`**: `SlateContent` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`status`**: `Furtheractionstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query FurtherAction($id: ID!) { furtherAction(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "furtherAction": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } } ``` # furtherActionApproval Source: https://docs.firstresonance.io/api-reference/queries/furtherActionApproval Retrieves an item by its ID. **query** `furtherActionApproval(id: ID!): FurtherActionApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `FurtherActionApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `FurtherActionApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[FurtherActionApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query FurtherActionApproval($id: ID!) { furtherActionApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "furtherActionApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # furtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/furtherActionApprovalRequest Retrieves an item by its ID. **query** `furtherActionApprovalRequest(id: ID!): FurtherActionApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `FurtherActionApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query FurtherActionApprovalRequest($id: ID!) { furtherActionApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "furtherActionApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # furtherActionApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/furtherActionApprovalRequests Retrieves a list of items. **query** `furtherActionApprovalRequests(after: String, before: String, distinctOn: [FurtherActionApprovalRequestSortEnum], filters: FurtherActionApprovalRequestsInputFilters, first: Int, last: Int, sort: [FurtherActionApprovalRequestSortEnum]): FurtherActionApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionApprovalRequestSortEnum]` --- **`filters`**: `FurtherActionApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionApprovalRequestSortEnum]` ## Returns `FurtherActionApprovalRequestsConnection` **`edges`**: `[FurtherActionApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActionApprovalRequests { furtherActionApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActionApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherActionApprovalRoles Source: https://docs.firstresonance.io/api-reference/queries/furtherActionApprovalRoles Retrieves a list of items. **query** `furtherActionApprovalRoles(after: String, before: String, distinctOn: [FurtherActionApprovalRoleSortEnum], filters: FurtherActionApprovalRolesInputFilters, first: Int, last: Int, sort: [FurtherActionApprovalRoleSortEnum]): FurtherActionApprovalRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionApprovalRoleSortEnum]` --- **`filters`**: `FurtherActionApprovalRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionApprovalRoleSortEnum]` ## Returns `FurtherActionApprovalRolesConnection` **`edges`**: `[FurtherActionApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActionApprovalRoles { furtherActionApprovalRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActionApprovalRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherActionApprovals Source: https://docs.firstresonance.io/api-reference/queries/furtherActionApprovals Retrieves a list of items. **query** `furtherActionApprovals(after: String, before: String, distinctOn: [FurtherActionApprovalSortEnum], filters: FurtherActionApprovalsInputFilters, first: Int, last: Int, sort: [FurtherActionApprovalSortEnum]): FurtherActionApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionApprovalSortEnum]` --- **`filters`**: `FurtherActionApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionApprovalSortEnum]` ## Returns `FurtherActionApprovalsConnection` **`edges`**: `[FurtherActionApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActionApprovals { furtherActionApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActionApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherActionIssue Source: https://docs.firstresonance.io/api-reference/queries/furtherActionIssue Retrieves an item by its ID. **query** `furtherActionIssue(furtherActionId: ID!, issueId: ID!): FurtherActionIssue` ## Arguments **`furtherActionId`**: `ID!` (required) --- **`issueId`**: `ID!` (required) ## Returns `FurtherActionIssue` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`id`**: `ID` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionIssueEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query FurtherActionIssue($furtherActionId: ID!, $issueId: ID!) { furtherActionIssue(furtherActionId: $furtherActionId, issueId: $issueId) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } ``` ```json Variables { "furtherActionId": "id", "issueId": "id" } ``` ```json Response { "data": { "furtherActionIssue": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } ``` # furtherActionIssues Source: https://docs.firstresonance.io/api-reference/queries/furtherActionIssues Retrieves a list of items. **query** `furtherActionIssues(after: String, before: String, distinctOn: [FurtherActionIssueSortEnum], filters: FurtherActionIssuesInputFilters, first: Int, last: Int, sort: [FurtherActionIssueSortEnum]): FurtherActionIssuesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionIssueSortEnum]` --- **`filters`**: `FurtherActionIssuesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionIssueSortEnum]` ## Returns `FurtherActionIssuesConnection` **`edges`**: `[FurtherActionIssuesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActionIssues { furtherActionIssues { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActionIssues": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherActionPart Source: https://docs.firstresonance.io/api-reference/queries/furtherActionPart Retrieves an item by its ID. **query** `furtherActionPart(furtherActionId: ID!, partId: ID!): FurtherActionPart` ## Arguments **`furtherActionId`**: `ID!` (required) --- **`partId`**: `ID!` (required) ## Returns `FurtherActionPart` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`id`**: `ID` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionPartEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query FurtherActionPart($furtherActionId: ID!, $partId: ID!) { furtherActionPart(furtherActionId: $furtherActionId, partId: $partId) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } ``` ```json Variables { "furtherActionId": "id", "partId": "id" } ``` ```json Response { "data": { "furtherActionPart": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } ``` # furtherActionParts Source: https://docs.firstresonance.io/api-reference/queries/furtherActionParts Retrieves a list of items. **query** `furtherActionParts(after: String, before: String, distinctOn: [FurtherActionPartSortEnum], filters: FurtherActionPartsInputFilters, first: Int, last: Int, sort: [FurtherActionPartSortEnum]): FurtherActionPartsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionPartSortEnum]` --- **`filters`**: `FurtherActionPartsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionPartSortEnum]` ## Returns `FurtherActionPartsConnection` **`edges`**: `[FurtherActionPartsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActionParts { furtherActionParts { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActionParts": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherActionRun Source: https://docs.firstresonance.io/api-reference/queries/furtherActionRun Retrieves an item by its ID. **query** `furtherActionRun(furtherActionId: ID!, runId: ID!): FurtherActionRun` ## Arguments **`furtherActionId`**: `ID!` (required) --- **`runId`**: `ID!` (required) ## Returns `FurtherActionRun` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionRunEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query FurtherActionRun($furtherActionId: ID!, $runId: ID!) { furtherActionRun(furtherActionId: $furtherActionId, runId: $runId) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } ``` ```json Variables { "furtherActionId": "id", "runId": "id" } ``` ```json Response { "data": { "furtherActionRun": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } ``` # furtherActionRuns Source: https://docs.firstresonance.io/api-reference/queries/furtherActionRuns Retrieves a list of items. **query** `furtherActionRuns(after: String, before: String, distinctOn: [FurtherActionRunSortEnum], filters: FurtherActionRunsInputFilters, first: Int, last: Int, sort: [FurtherActionRunSortEnum]): FurtherActionRunsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionRunSortEnum]` --- **`filters`**: `FurtherActionRunsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionRunSortEnum]` ## Returns `FurtherActionRunsConnection` **`edges`**: `[FurtherActionRunsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActionRuns { furtherActionRuns { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActionRuns": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # furtherActions Source: https://docs.firstresonance.io/api-reference/queries/furtherActions Retrieves a list of items. **query** `furtherActions(after: String, before: String, distinctOn: [FurtherActionSortEnum], filters: FurtherActionsInputFilters, first: Int, last: Int, sort: [FurtherActionSortEnum]): FurtherActionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[FurtherActionSortEnum]` --- **`filters`**: `FurtherActionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[FurtherActionSortEnum]` ## Returns `FurtherActionsConnection` **`edges`**: `[FurtherActionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query FurtherActions { furtherActions { edges { cursor node { Attributes { __typename } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "furtherActions": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "FurtherActionAttribute" } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # getKitItemsImporterTemplateUrl Source: https://docs.firstresonance.io/api-reference/queries/getKitItemsImporterTemplateUrl Retrieves the URL for a kit items importer template. **query** `getKitItemsImporterTemplateUrl: GetKitItemsImporterTemplateUrl` ## Returns `GetKitItemsImporterTemplateUrl` **`downloadUrl`**: `String!` ## Examples ```graphql Query query GetKitItemsImporterTemplateUrl { getKitItemsImporterTemplateUrl { downloadUrl } } ``` ```json Response { "data": { "getKitItemsImporterTemplateUrl": { "downloadUrl": "string" } } } ``` # getMbomImporterTemplateUrl Source: https://docs.firstresonance.io/api-reference/queries/getMbomImporterTemplateUrl Retrieves the URL for an mBOM importer template. **query** `getMbomImporterTemplateUrl(isLevel: Boolean!): GetMBomImporterTemplateUrl` ## Arguments **`isLevel`**: `Boolean!` (required) ## Returns `GetMBomImporterTemplateUrl` **`downloadUrl`**: `String!` ## Examples ```graphql Query query GetMbomImporterTemplateUrl($isLevel: Boolean!) { getMbomImporterTemplateUrl(isLevel: $isLevel) { downloadUrl } } ``` ```json Variables { "isLevel": true } ``` ```json Response { "data": { "getMbomImporterTemplateUrl": { "downloadUrl": "string" } } } ``` # globalUniqueSerialNumber Source: https://docs.firstresonance.io/api-reference/queries/globalUniqueSerialNumber Retrieves a global unique serial number. Can be used to predict the next value. **query** `globalUniqueSerialNumber(lastGeneratedValue: Boolean, name: String, unsafePredictNextValue: Boolean): GlobalUniqueSerialNumber` ## Arguments **`lastGeneratedValue`**: `Boolean` --- **`name`**: `String` --- **`unsafePredictNextValue`**: `Boolean` Predict next serial number without directly calling sequence. ## Returns `GlobalUniqueSerialNumber` **`serialNumber`**: `String` ## Examples ```graphql Query query GlobalUniqueSerialNumber { globalUniqueSerialNumber { serialNumber } } ``` ```json Response { "data": { "globalUniqueSerialNumber": { "serialNumber": "string" } } } ``` # importJob Source: https://docs.firstresonance.io/api-reference/queries/importJob Retrieves an item by its ID. **query** `importJob(id: ID!): ImportJob` ## Arguments **`id`**: `ID!` (required) ## Returns `ImportJob` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityId`**: `Int!` --- **`errors`**: `JSONString!` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`filename`**: `String` --- **`id`**: `Int!` --- **`importDuration`**: `Int` --- **`importOptions`**: `JSONString!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`numRows`**: `Int` --- **`prettyStr`**: `String` --- **`status`**: `ImportJobStatus!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ImportJobEventFilter` --- **`type`**: `Importjobtypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ImportJob($id: ID!) { importJob(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "importJob": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # importJobs Source: https://docs.firstresonance.io/api-reference/queries/importJobs Retrieves a list of items. **query** `importJobs(after: String, before: String, distinctOn: [ImportJobSortEnum], filters: ImportJobsInputFilters, first: Int, last: Int, sort: [ImportJobSortEnum]): ImportJobsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ImportJobSortEnum]` --- **`filters`**: `ImportJobsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ImportJobSortEnum]` ## Returns `ImportJobsConnection` **`edges`**: `[ImportJobsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ImportJobs { importJobs { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "importJobs": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # intentOption Source: https://docs.firstresonance.io/api-reference/queries/intentOption Retrieves an item by its ID. **query** `intentOption(id: ID!): IntentOption` ## Arguments **`id`**: `ID!` (required) ## Returns `IntentOption` **`LastSessionId`**: `String` --- **`_IssueDispositionTypesCount`**: `Int` Optimized count of issueDispositionTypes. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`isReceivingInspectionRunRequired`**: `Boolean` --- **`issueDispositionTypes`**: `[IssueDispositionType]` **Arguments:** - `filters`: `IssueDispositionTypesInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`rank`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IntentOptionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String` ## Examples ```graphql Query query IntentOption($id: ID!) { intentOption(id: $id) { LastSessionId _IssueDispositionTypesCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "intentOption": { "LastSessionId": "string", "_IssueDispositionTypesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # intentOptions Source: https://docs.firstresonance.io/api-reference/queries/intentOptions Retrieves a list of items. **query** `intentOptions(after: String, before: String, distinctOn: [IntentOptionSortEnum], filters: IntentOptionsInputFilters, first: Int, last: Int, sort: [IntentOptionSortEnum]): IntentOptionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IntentOptionSortEnum]` --- **`filters`**: `IntentOptionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IntentOptionSortEnum]` ## Returns `IntentOptionsConnection` **`edges`**: `[IntentOptionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IntentOptions { intentOptions { edges { cursor node { LastSessionId _IssueDispositionTypesCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "intentOptions": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_IssueDispositionTypesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # intercomIntegration Source: https://docs.firstresonance.io/api-reference/queries/intercomIntegration Retrieves information about the Intercom integration. **query** `intercomIntegration: IntercomIntegration` ## Returns `IntercomIntegration` **`userHash`**: `String` ## Examples ```graphql Query query IntercomIntegration { intercomIntegration { userHash } } ``` ```json Response { "data": { "intercomIntegration": { "userHash": "string" } } } ``` # invite Source: https://docs.firstresonance.io/api-reference/queries/invite Retrieves an item by its ID. **query** `invite(id: ID!): Invite` ## Arguments **`id`**: `ID!` (required) ## Returns `Invite` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`auth0InvitationId`**: `String` --- **`auth0OrgId`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`email`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`message`**: `String` --- **`name`**: `String` --- **`prettyStr`**: `String` --- **`resendCount`**: `Int` --- **`status`**: `InvitesStatusEnum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `InviteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Invite($id: ID!) { invite(id: $id) { LastSessionId _created _etag _updated auth0InvitationId auth0OrgId } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "invite": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0InvitationId": "string", "auth0OrgId": "string" } } } ``` # invites Source: https://docs.firstresonance.io/api-reference/queries/invites Retrieves a list of items. **query** `invites(after: String, before: String, distinctOn: [InviteSortEnum], filters: InvitesInputFilters, first: Int, last: Int, sort: [InviteSortEnum]): InvitesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[InviteSortEnum]` --- **`filters`**: `InvitesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[InviteSortEnum]` ## Returns `InvitesConnection` **`edges`**: `[InvitesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Invites { invites { edges { cursor node { LastSessionId _created _etag _updated auth0InvitationId auth0OrgId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "invites": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0InvitationId": "string", "auth0OrgId": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issue Source: https://docs.firstresonance.io/api-reference/queries/issue Retrieves an item by its ID. **query** `issue(id: ID!): Issue` ## Arguments **`id`**: `ID!` (required) ## Returns `Issue` **`Attributes`**: `[IssueAttribute]` **Arguments:** - `filters`: `IssueAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FurtherActionsCount`**: `Int` Optimized count of furtherActions. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_OriginIssuesCount`**: `Int` Optimized count of originIssues. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_RedlinesCount`**: `Int` Optimized count of redlines. --- **`_RelatedIssuesCount`**: `Int` --- **`_SiblingIssuesCount`**: `Int` Optimized count of siblingIssues. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[IssueApprovalRequest]` **Arguments:** - `filters`: `IssueApprovalRequestsInputFilters` --- **`approvals`**: `[IssueApproval]` **Arguments:** - `filters`: `IssueApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[IssueAttributedPart]` **Arguments:** - `filters`: `IssueAttributedPartsInputFilters` --- **`attributedUsers`**: `[IssueAttributedUser]` **Arguments:** - `filters`: `IssueAttributedUsersInputFilters` --- **`attributes`**: `[IssueAttribute]` --- **`batchSiblings`**: `[Issue]` --- **`batched`**: `String` --- **`causeCondition`**: `SlateContent` --- **`comments`**: `[Comment]` --- **`createIssueForEachBatchSibling`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`disposition`**: `SlateContent` --- **`editable`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`expectedCondition`**: `SlateContent` --- **`fileAttachments`**: `[FileAttachment]` --- **`fixPartInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`fixPartInventoryId`**: `Int` --- **`furtherActions`**: `[FurtherAction]` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`id`**: `Int!` --- **`issueDispositionType`**: `IssueDispositionType` **Arguments:** - `filters`: `IssueDispositionTypesInputFilters` --- **`issueDispositionTypeId`**: `Int` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mustCloseByRunStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`mustCloseByRunStepId`**: `Int` --- **`originIssues`**: `[Issue]` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventory`**: `PartInventory` Get first part inventory tied to issue. To get all part inventories please use the partInventories field. This field is now deprecated. > Deprecated: Issues can now have multiple part inventories tied to them. --- **`partInventoryId`**: `Int` Part inventory id. > Deprecated: Issues can now have multiple part inventories tied to them. --- **`prettyStr`**: `String` --- **`purchaseOrderLine`**: `PurchaseOrderLine` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `Int` --- **`redlines`**: `[Redline]` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`relatedIssues`**: `[Issue]` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`siblingIssues`**: `[Issue]` --- **`status`**: `Issuestatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueEventFilter` --- **`title`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Issue($id: ID!) { issue(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "issue": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } } ``` # issueApproval Source: https://docs.firstresonance.io/api-reference/queries/issueApproval Retrieves an item by its ID. **query** `issueApproval(id: ID!): IssueApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `IssueApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`issueId`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `IssueApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[IssueApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query IssueApproval($id: ID!) { issueApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "issueApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # issueApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/issueApprovalRequest Retrieves an item by its ID. **query** `issueApprovalRequest(id: ID!): IssueApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `IssueApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`issueId`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query IssueApprovalRequest($id: ID!) { issueApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "issueApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # issueApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/issueApprovalRequests Retrieves a list of items. **query** `issueApprovalRequests(after: String, before: String, distinctOn: [IssueApprovalRequestSortEnum], filters: IssueApprovalRequestsInputFilters, first: Int, last: Int, sort: [IssueApprovalRequestSortEnum]): IssueApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssueApprovalRequestSortEnum]` --- **`filters`**: `IssueApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssueApprovalRequestSortEnum]` ## Returns `IssueApprovalRequestsConnection` **`edges`**: `[IssueApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IssueApprovalRequests { issueApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issueApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issueApprovals Source: https://docs.firstresonance.io/api-reference/queries/issueApprovals Retrieves a list of items. **query** `issueApprovals(after: String, before: String, distinctOn: [IssueApprovalSortEnum], filters: IssueApprovalsInputFilters, first: Int, last: Int, sort: [IssueApprovalSortEnum]): IssueApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssueApprovalSortEnum]` --- **`filters`**: `IssueApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssueApprovalSortEnum]` ## Returns `IssueApprovalsConnection` **`edges`**: `[IssueApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IssueApprovals { issueApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issueApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issueDispositionType Source: https://docs.firstresonance.io/api-reference/queries/issueDispositionType Retrieves an item by its ID. **query** `issueDispositionType(id: ID!): IssueDispositionType` ## Arguments **`id`**: `ID!` (required) ## Returns `IssueDispositionType` **`LastSessionId`**: `String` --- **`_IssueDispositionTypeRolesCount`**: `Int` Optimized count of issueDispositionTypeRoles. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_RolesCount`**: `Int` Optimized count of roles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`active`**: `Boolean!` --- **`autoResolve`**: `Boolean!` --- **`availabilityBehavior`**: `IssueDispositionTypeAvailabilityBehavior` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` --- **`issueDispositionTypeRoles`**: `[IssueDispositionTypeRole]` **Arguments:** - `filters`: `IssueDispositionTypeRolesInputFilters` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueDispositionTypeEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query IssueDispositionType($id: ID!) { issueDispositionType(id: $id) { LastSessionId _IssueDispositionTypeRolesCount _IssuesCount _RolesCount _created _etag } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "issueDispositionType": { "LastSessionId": "string", "_IssueDispositionTypeRolesCount": 1, "_IssuesCount": 1, "_RolesCount": 1, "_created": "value", "_etag": "string" } } } ``` # issueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/queries/issueDispositionTypeRole Retrieves an item by its ID. **query** `issueDispositionTypeRole(gateType: gateTypeissueapprovalgatetypeenum!, issueDispositionTypeId: ID!, roleId: ID!): IssueDispositionTypeRole` ## Arguments **`gateType`**: `gateTypeissueapprovalgatetypeenum!` (required) --- **`issueDispositionTypeId`**: `ID!` (required) --- **`roleId`**: `ID!` (required) ## Returns `IssueDispositionTypeRole` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`issueDispositionType`**: `IssueDispositionType` **Arguments:** - `filters`: `IssueDispositionTypesInputFilters` --- **`issueDispositionTypeId`**: `Int` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueDispositionTypeRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query IssueDispositionTypeRole($gateType: gateTypeissueapprovalgatetypeenum!, $issueDispositionTypeId: ID!, $roleId: ID!) { issueDispositionTypeRole(gateType: $gateType, issueDispositionTypeId: $issueDispositionTypeId, roleId: $roleId) { LastSessionId _created _etag _updated count createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "gateType": "IN_PROGRESS", "issueDispositionTypeId": "id", "roleId": "id" } ``` ```json Response { "data": { "issueDispositionTypeRole": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # issueDispositionTypeRoles Source: https://docs.firstresonance.io/api-reference/queries/issueDispositionTypeRoles Retrieves a list of items. **query** `issueDispositionTypeRoles(after: String, before: String, distinctOn: [IssueDispositionTypeRoleSortEnum], filters: IssueDispositionTypeRolesInputFilters, first: Int, last: Int, sort: [IssueDispositionTypeRoleSortEnum]): IssueDispositionTypeRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssueDispositionTypeRoleSortEnum]` --- **`filters`**: `IssueDispositionTypeRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssueDispositionTypeRoleSortEnum]` ## Returns `IssueDispositionTypeRolesConnection` **`edges`**: `[IssueDispositionTypeRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IssueDispositionTypeRoles { issueDispositionTypeRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issueDispositionTypeRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issueDispositionTypes Source: https://docs.firstresonance.io/api-reference/queries/issueDispositionTypes Retrieves a list of items. **query** `issueDispositionTypes(after: String, before: String, distinctOn: [IssueDispositionTypeSortEnum], filters: IssueDispositionTypesInputFilters, first: Int, last: Int, sort: [IssueDispositionTypeSortEnum]): IssueDispositionTypesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssueDispositionTypeSortEnum]` --- **`filters`**: `IssueDispositionTypesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssueDispositionTypeSortEnum]` ## Returns `IssueDispositionTypesConnection` **`edges`**: `[IssueDispositionTypesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IssueDispositionTypes { issueDispositionTypes { edges { cursor node { LastSessionId _IssueDispositionTypeRolesCount _IssuesCount _RolesCount _created _etag } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issueDispositionTypes": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_IssueDispositionTypeRolesCount": 1, "_IssuesCount": 1, "_RolesCount": 1, "_created": "value", "_etag": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issuePartInventories Source: https://docs.firstresonance.io/api-reference/queries/issuePartInventories Retrieves a list of items. **query** `issuePartInventories(after: String, before: String, distinctOn: [IssuePartInventorySortEnum], filters: IssuePartInventoriesInputFilters, first: Int, last: Int, sort: [IssuePartInventorySortEnum]): IssuePartInventoriesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssuePartInventorySortEnum]` --- **`filters`**: `IssuePartInventoriesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssuePartInventorySortEnum]` ## Returns `IssuePartInventoriesConnection` **`edges`**: `[IssuePartInventoriesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IssuePartInventories { issuePartInventories { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issuePartInventories": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issuePartInventory Source: https://docs.firstresonance.io/api-reference/queries/issuePartInventory Retrieves an item by its ID. **query** `issuePartInventory(issueId: ID!, partInventoryId: ID!): IssuePartInventory` ## Arguments **`issueId`**: `ID!` (required) --- **`partInventoryId`**: `ID!` (required) ## Returns `IssuePartInventory` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`fromSplitInventory`**: `Boolean!` --- **`id`**: `ID` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueId`**: `Int` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssuePartInventoryEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query IssuePartInventory($issueId: ID!, $partInventoryId: ID!) { issuePartInventory(issueId: $issueId, partInventoryId: $partInventoryId) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } ``` ```json Variables { "issueId": "id", "partInventoryId": "id" } ``` ```json Response { "data": { "issuePartInventory": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } ``` # issueRelations Source: https://docs.firstresonance.io/api-reference/queries/issueRelations Retrieves a list of items. **query** `issueRelations(after: String, before: String, distinctOn: [IssueRelationSortEnum], filters: IssueRelationsInputFilters, first: Int, last: Int, sort: [IssueRelationSortEnum]): IssueRelationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssueRelationSortEnum]` --- **`filters`**: `IssueRelationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssueRelationSortEnum]` ## Returns `IssueRelationsConnection` **`edges`**: `[IssueRelationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query IssueRelations { issueRelations { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issueRelations": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # issues Source: https://docs.firstresonance.io/api-reference/queries/issues Retrieves a list of items. **query** `issues(after: String, before: String, distinctOn: [IssueSortEnum], filters: IssueInputFilters, first: Int, last: Int, sort: [IssueSortEnum]): IssuesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[IssueSortEnum]` --- **`filters`**: `IssueInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[IssueSortEnum]` ## Returns `IssuesConnection` **`edges`**: `[IssuesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Issues { issues { edges { cursor node { Attributes { __typename } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AssigneesCount _AttributedPartsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "issues": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "IssueAttribute" } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1, "_AttributedPartsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # label Source: https://docs.firstresonance.io/api-reference/queries/label Retrieves an item by its ID. **query** `label(id: ID!): Label` ## Arguments **`id`**: `ID!` (required) ## Returns `Label` **`LastSessionId`**: `String` --- **`_EntitiesCount`**: `Int` Optimized count of entities. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LabelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String` ## Examples ```graphql Query query Label($id: ID!) { label(id: $id) { LastSessionId _EntitiesCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "label": { "LastSessionId": "string", "_EntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # labels Source: https://docs.firstresonance.io/api-reference/queries/labels Retrieves a list of items. **query** `labels(after: String, before: String, distinctOn: [LabelSortEnum], filters: LabelsInputFilters, first: Int, last: Int, sort: [LabelSortEnum]): LabelsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[LabelSortEnum]` --- **`filters`**: `LabelsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[LabelSortEnum]` ## Returns `LabelsConnection` **`edges`**: `[LabelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Labels { labels { edges { cursor node { LastSessionId _EntitiesCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "labels": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_EntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # location Source: https://docs.firstresonance.io/api-reference/queries/location Retrieves an item by its ID. **query** `location(id: ID!): Location` ## Arguments **`id`**: `ID!` (required) ## Returns `Location` **`Attributes`**: `[LocationAttribute]` **Arguments:** - `filters`: `LocationAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AllChildrenCount`**: `Int` --- **`_AllParentsCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_ExpectedPartKitsCount`**: `Int` Optimized count of expectedPartKits. --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PartKitsCount`**: `Int` Optimized count of partKits. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_UsersCount`**: `Int` Optimized count of users. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`address`**: `String` --- **`allChildren`**: `[Location]` --- **`allParents`**: `[Location]` --- **`archived`**: `Boolean!` --- **`attributedParts`**: `[LocationAttributedPart]` **Arguments:** - `filters`: `LocationAttributedPartsInputFilters` --- **`attributedUsers`**: `[LocationAttributedUser]` **Arguments:** - `filters`: `LocationAttributedUsersInputFilters` --- **`attributes`**: `[LocationAttribute]` --- **`available`**: `Boolean!` --- **`canHoldInventory`**: `Boolean!` --- **`contact`**: `Contact` **Arguments:** - `filters`: `ContactsInputFilters` --- **`contactId`**: `Int` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`excludeFromMergePartInventory`**: `Boolean` Exclude the location from inventory merge (V2 merge only). --- **`expectedPartKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`id`**: `Int!` --- **`image`**: `FileAttachment` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`imageId`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`latitude`**: `Float` --- **`locationSubtype`**: `LocationSubtype` **Arguments:** - `filters`: `LocationSubtypesInputFilters` --- **`locationSubtypeId`**: `Int` --- **`locations`**: `[Location]` --- **`longitude`**: `Float` --- **`name`**: `String!` --- **`parent`**: `Location` --- **`parentId`**: `Int` --- **`parentName`**: `String` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`pickSequence`**: `Int` --- **`pickable`**: `Boolean!` --- **`prettyStr`**: `String` --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` --- **`supervisor`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`supervisorId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LocationEventFilter` --- **`type`**: `Locationtypeenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`users`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` ## Examples ```graphql Query query Location($id: ID!) { location(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AllChildrenCount _AllParentsCount _AttributedPartsCount _AttributedUsersCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "location": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } ``` # locationSubtype Source: https://docs.firstresonance.io/api-reference/queries/locationSubtype Retrieves an item by its ID. **query** `locationSubtype(id: ID!): LocationSubtype` ## Arguments **`id`**: `ID!` (required) ## Returns `LocationSubtype` **`LastSessionId`**: `String` --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` **Arguments:** - `filters`: `LocationsInputFilters` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LocationSubtypeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query LocationSubtype($id: ID!) { locationSubtype(id: $id) { LastSessionId _LocationsCount _StepsCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "locationSubtype": { "LastSessionId": "string", "_LocationsCount": 1, "_StepsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # locationSubtypes Source: https://docs.firstresonance.io/api-reference/queries/locationSubtypes Retrieves a list of items. **query** `locationSubtypes(after: String, before: String, distinctOn: [LocationSubtypeSortEnum], filters: LocationSubtypesInputFilters, first: Int, last: Int, sort: [LocationSubtypeSortEnum]): LocationSubtypesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[LocationSubtypeSortEnum]` --- **`filters`**: `LocationSubtypesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[LocationSubtypeSortEnum]` ## Returns `LocationSubtypesConnection` **`edges`**: `[LocationSubtypesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query LocationSubtypes { locationSubtypes { edges { cursor node { LastSessionId _LocationsCount _StepsCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "locationSubtypes": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_LocationsCount": 1, "_StepsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # locations Source: https://docs.firstresonance.io/api-reference/queries/locations Retrieves a list of items. **query** `locations(after: String, before: String, distinctOn: [LocationSortEnum], filters: LocationsInputFilters, first: Int, last: Int, sort: [LocationSortEnum]): LocationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[LocationSortEnum]` --- **`filters`**: `LocationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[LocationSortEnum]` ## Returns `LocationsConnection` **`edges`**: `[LocationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Locations { locations { edges { cursor node { Attributes { __typename } LastSessionId _AllChildrenCount _AllParentsCount _AttributedPartsCount _AttributedUsersCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "locations": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "LocationAttribute" } ], "LastSessionId": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # loggedActions Source: https://docs.firstresonance.io/api-reference/queries/loggedActions Retrieves a list of items. **query** `loggedActions(after: String, before: String, distinctOn: [LoggedActionSortEnum], filters: LoggedActionsInputFilters, first: Int, last: Int, sort: [LoggedActionSortEnum]): LoggedActionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[LoggedActionSortEnum]` --- **`filters`**: `LoggedActionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[LoggedActionSortEnum]` ## Returns `LoggedActionsConnection` **`edges`**: `[LoggedActionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query LoggedActions { loggedActions { edges { cursor node { action apiClientId changedFields depth eventId id } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "loggedActions": { "edges": [ { "cursor": "string", "node": { "action": "CHILD_ADDED", "apiClientId": 1, "changedFields": "value", "depth": 1, "eventId": 1, "id": "id" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbom Source: https://docs.firstresonance.io/api-reference/queries/mbom Retrieves an item by its ID. **query** `mbom(id: ID!): MBom` ## Arguments **`id`**: `ID!` (required) ## Returns `MBom` **`Attributes`**: `[MbomAttribute]` **Arguments:** - `filters`: `MbomAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MbomItemsCount`**: `Int` Optimized count of mbom items. --- **`_PartsInventoriesCount`**: `Int` Optimized count of partsInventories. --- **`_ProcedureMbomItemsCount`**: `Int` Optimized count of procedureMbomItems. --- **`_ProcedureMbomsCount`**: `Int` Optimized count of procedureMboms. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[MBomApprovalRequest]` **Arguments:** - `filters`: `MBomApprovalRequestsInputFilters` --- **`approvals`**: `[MBomApproval]` **Arguments:** - `filters`: `MBomApprovalsInputFilters` --- **`attributedParts`**: `[MBomAttributedPart]` **Arguments:** - `filters`: `MBomAttributedPartsInputFilters` --- **`attributedUsers`**: `[MBomAttributedUser]` **Arguments:** - `filters`: `MBomAttributedUsersInputFilters` --- **`attributes`**: `[MbomAttribute]` --- **`comments`**: `[Comment]` **Arguments:** - `filters`: `CommentsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `Int!` --- **`isLatestReleasedVersion`**: `Boolean` --- **`isLatestVersion`**: `Boolean` --- **`labels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItems`**: `[MBomItem]` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partsInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`prettyStr`**: `String` --- **`procedureMbomItems`**: `[ProcedureMBomItem]` **Arguments:** - `filters`: `ProcedureMBomItemsInputFilters` --- **`procedureMboms`**: `[ProcedureMBom]` **Arguments:** - `filters`: `ProcedureMBomsInputFilters` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`status`**: `Mbomstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`version`**: `Int!` ## Examples ```graphql Query query Mbom($id: ID!) { mbom(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbom": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } ``` # mbomApproval Source: https://docs.firstresonance.io/api-reference/queries/mbomApproval Retrieves an item by its ID. **query** `mbomApproval(id: ID!): MBomApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `MBomApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Mbomapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int!` --- **`parent`**: `MBomApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[MBomApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MbomApproval($id: ID!) { mbomApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # mbomApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/mbomApprovalRequest Retrieves an item by its ID. **query** `mbomApprovalRequest(id: ID!): MBomApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `MBomApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Mbomapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int!` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MbomApprovalRequest($id: ID!) { mbomApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # mbomApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/mbomApprovalRequests Retrieves a list of items. **query** `mbomApprovalRequests(after: String, before: String, distinctOn: [MBomApprovalRequestSortEnum], filters: MBomApprovalRequestsInputFilters, first: Int, last: Int, sort: [MBomApprovalRequestSortEnum]): MBomApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomApprovalRequestSortEnum]` --- **`filters`**: `MBomApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomApprovalRequestSortEnum]` ## Returns `MBomApprovalRequestsConnection` **`edges`**: `[MBomApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomApprovalRequests { mbomApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomApprovalRoles Source: https://docs.firstresonance.io/api-reference/queries/mbomApprovalRoles Retrieves a list of items. **query** `mbomApprovalRoles(after: String, before: String, distinctOn: [MBomApprovalRoleSortEnum], filters: MBomApprovalRolesInputFilters, first: Int, last: Int, sort: [MBomApprovalRoleSortEnum]): MBomApprovalRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomApprovalRoleSortEnum]` --- **`filters`**: `MBomApprovalRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomApprovalRoleSortEnum]` ## Returns `MBomApprovalRolesConnection` **`edges`**: `[MBomApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomApprovalRoles { mbomApprovalRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomApprovalRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomApprovals Source: https://docs.firstresonance.io/api-reference/queries/mbomApprovals Retrieves a list of items. **query** `mbomApprovals(after: String, before: String, distinctOn: [MBomApprovalSortEnum], filters: MBomApprovalsInputFilters, first: Int, last: Int, sort: [MBomApprovalSortEnum]): MBomApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomApprovalSortEnum]` --- **`filters`**: `MBomApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomApprovalSortEnum]` ## Returns `MBomApprovalsConnection` **`edges`**: `[MBomApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomApprovals { mbomApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomChangeOrderCandidateInventories Source: https://docs.firstresonance.io/api-reference/queries/mbomChangeOrderCandidateInventories The target part's inventories not yet on this mBOM change order, each with the verdict a createMbomChangeOrderLines call would give it. **query** `mbomChangeOrderCandidateInventories(after: String, before: String, changeOrderId: Int!, filters: MbomChangeOrderCandidateInventoryInputFilters, first: Int, last: Int): MbomChangeOrderCandidateInventoryConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`changeOrderId`**: `Int!` (required) --- **`filters`**: `MbomChangeOrderCandidateInventoryInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` ## Returns `MbomChangeOrderCandidateInventoryConnection` **`edges`**: `[MbomChangeOrderCandidateInventoryEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomChangeOrderCandidateInventories($changeOrderId: Int!) { mbomChangeOrderCandidateInventories(changeOrderId: $changeOrderId) { edges { cursor node { id ineligibleReason partInventory { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Variables { "changeOrderId": 1 } ``` ```json Response { "data": { "mbomChangeOrderCandidateInventories": { "edges": [ { "cursor": "string", "node": { "id": "id", "ineligibleReason": "EMPTY", "partInventory": { "__typename": "PartInventory" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomChangeOrderLine Source: https://docs.firstresonance.io/api-reference/queries/mbomChangeOrderLine Retrieves an item by its ID. **query** `mbomChangeOrderLine(id: ID!): MbomChangeOrderLine` ## Arguments **`id`**: `ID!` (required) ## Returns `MbomChangeOrderLine` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`appliedAt`**: `DateTime` --- **`appliedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`appliedById`**: `Int` --- **`canceledAt`**: `DateTime` --- **`canceledBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`canceledById`**: `Int` --- **`changeOrder`**: `ChangeOrder` **Arguments:** - `filters`: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`diffs`**: `[MbomChangeOrderLineDiff]` --- **`hasDrift`**: `Boolean` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`sourceMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`sourceMbomId`**: `Int` --- **`status`**: `ChangeOrderLineStatus` --- **`targetMbom`**: `MBom` --- **`targetMbomId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MbomChangeOrderLineEventFilter` --- **`totalDiffCount`**: `Int` --- **`unconfirmedDiffCount`**: `Int` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MbomChangeOrderLine($id: ID!) { mbomChangeOrderLine(id: $id) { LastSessionId _created _etag _updated appliedAt appliedBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomChangeOrderLine": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "appliedAt": "value", "appliedBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # mbomChangeOrderLineDiff Source: https://docs.firstresonance.io/api-reference/queries/mbomChangeOrderLineDiff Retrieves an item by its ID. **query** `mbomChangeOrderLineDiff(id: ID!): MbomChangeOrderLineDiff` ## Arguments **`id`**: `ID!` (required) ## Returns `MbomChangeOrderLineDiff` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` --- **`buildRequirementId`**: `Int` --- **`changeOrderId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`currentTotalQuantity`**: `Float` --- **`diffType`**: `MbomChangeDiffType!` --- **`finalState`**: `MbomChangeOrderLineRequirementState` --- **`id`**: `Int!` --- **`initialState`**: `MbomChangeOrderLineRequirementState` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomChangeOrderLine`**: `MbomChangeOrderLine` --- **`mbomChangeOrderLineId`**: `Int!` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`resolutionConfirmedAt`**: `DateTime` --- **`resolutionConfirmedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`resolutionConfirmedById`**: `Int` --- **`resolutionOptions`**: `[MbomChangeOrderLineResolutionOption]` --- **`resolutionType`**: `MbomChangeResolution` --- **`targetTotalQuantity`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MbomChangeOrderLineDiffEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MbomChangeOrderLineDiff($id: ID!) { mbomChangeOrderLineDiff(id: $id) { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomChangeOrderLineDiff": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } ``` # mbomChangeOrderLineDiffs Source: https://docs.firstresonance.io/api-reference/queries/mbomChangeOrderLineDiffs Retrieves a list of items. **query** `mbomChangeOrderLineDiffs(after: String, before: String, distinctOn: [MbomChangeOrderLineDiffSortEnum], filters: MbomChangeOrderLineDiffsInputFilters, first: Int, last: Int, sort: [MbomChangeOrderLineDiffSortEnum]): MbomChangeOrderLineDiffsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MbomChangeOrderLineDiffSortEnum]` --- **`filters`**: `MbomChangeOrderLineDiffsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MbomChangeOrderLineDiffSortEnum]` ## Returns `MbomChangeOrderLineDiffsConnection` **`edges`**: `[MbomChangeOrderLineDiffsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomChangeOrderLineDiffs { mbomChangeOrderLineDiffs { edges { cursor node { LastSessionId _created _etag _updated buildRequirement { __typename } buildRequirementId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomChangeOrderLineDiffs": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "__typename": "BuildRequirement" }, "buildRequirementId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomChangeOrderLineDrift Source: https://docs.firstresonance.io/api-reference/queries/mbomChangeOrderLineDrift Drift detail for the named mBOM change order lines that have any: every part that no longer matches what the line's diffs recorded. A clean line, or an id that names no line, is absent from the result rather than an empty entry. **query** `mbomChangeOrderLineDrift(mbomChangeOrderLineIds: [Int]!): [MbomChangeOrderLineDrift]` ## Arguments **`mbomChangeOrderLineIds`**: `[Int]!` (required) ## Returns `[MbomChangeOrderLineDrift]` **`label`**: `String!` --- **`mbomChangeOrderLineId`**: `Int!` --- **`mismatches`**: `[MbomChangeOrderLineDriftMismatch]!` --- **`partInventoryId`**: `Int` ## Examples ```graphql Query query MbomChangeOrderLineDrift($mbomChangeOrderLineIds: [Int]!) { mbomChangeOrderLineDrift(mbomChangeOrderLineIds: $mbomChangeOrderLineIds) { label mbomChangeOrderLineId mismatches { kind partId partNumber sentence } partInventoryId } } ``` ```json Variables { "mbomChangeOrderLineIds": [ 1 ] } ``` ```json Response { "data": { "mbomChangeOrderLineDrift": [ { "label": "string", "mbomChangeOrderLineId": 1, "mismatches": [ { "kind": "string", "partId": 1, "partNumber": "string", "sentence": "string" } ], "partInventoryId": 1 } ] } } ``` # mbomChangeOrderLines Source: https://docs.firstresonance.io/api-reference/queries/mbomChangeOrderLines Retrieves a list of items. **query** `mbomChangeOrderLines(after: String, before: String, distinctOn: [MbomChangeOrderLineSortEnum], filters: MbomChangeOrderLinesInputFilters, first: Int, last: Int, sort: [MbomChangeOrderLineSortEnum]): MbomChangeOrderLinesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MbomChangeOrderLineSortEnum]` --- **`filters`**: `MbomChangeOrderLinesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MbomChangeOrderLineSortEnum]` ## Returns `MbomChangeOrderLinesConnection` **`edges`**: `[MbomChangeOrderLinesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomChangeOrderLines { mbomChangeOrderLines { edges { cursor node { LastSessionId _created _etag _updated appliedAt appliedBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomChangeOrderLines": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "appliedAt": "value", "appliedBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomExplosion Source: https://docs.firstresonance.io/api-reference/queries/mbomExplosion Fully-exploded multi-level mBOM for a root part/mBOM in a single request, with per-line level, parent part, and rolled-up quantity. **query** `mbomExplosion(after: String, before: String, first: Int, input: MBomExplosionInput!, last: Int): MBomExplosionConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`first`**: `Int` --- **`input`**: `MBomExplosionInput!` (required) --- **`last`**: `Int` ## Returns `MBomExplosionConnection` **`edges`**: `[MBomExplosionEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. ## Examples ```graphql Query query MbomExplosion($input: MBomExplosionInput!) { mbomExplosion(input: $input) { edges { cursor node { id level mbomItem { __typename } parentPartId quantity totalQuantity } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor } } } ``` ```json Variables { "input": { "partId": "id" } } ``` ```json Response { "data": { "mbomExplosion": { "edges": [ { "cursor": "string", "node": { "id": "id", "level": 1, "mbomItem": { "__typename": "MBomItem" }, "parentPartId": "id", "quantity": 1.5, "totalQuantity": 1.5 } } ], "pageInfo": { "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string" } } } } ``` # mbomItem Source: https://docs.firstresonance.io/api-reference/queries/mbomItem Retrieves an item by its ID. **query** `mbomItem(id: ID!): MBomItem` ## Arguments **`id`**: `ID!` (required) ## Returns `MBomItem` **`LastSessionId`**: `String` --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_ParentCount`**: `Int` --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_ProcedureMbomItemsCount`**: `Int` Optimized count of procedureMbomItems. --- **`_ReferenceDesignatorsCount`**: `Int` Optimized count of referenceDesignators. --- **`_StepPartRequirementsCount`**: `Int` Optimized count of stepPartRequirements. --- **`_SubstitutesCount`**: `Int` Optimized count of substitutes. --- **`_created`**: `DateTime` --- **`_deleted`**: `Boolean` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`excludeFromKit`**: `Boolean!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`madeOnAssembly`**: `Boolean!` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int!` --- **`parent`**: `Part` --- **`parentId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`prettyStr`**: `String` --- **`procedureMbomItems`**: `[ProcedureMBomItem]` **Arguments:** - `filters`: `ProcedureMBomItemsInputFilters` --- **`quantity`**: `Float!` --- **`referenceDesignators`**: `[MBomItemReferenceDesignator]` **Arguments:** - `filters`: `MBomItemReferenceDesignatorsInputFilters` --- **`stepPartRequirements`**: `[StepPartRequirement]` **Arguments:** - `filters`: `StepPartRequirementsInputFilters` --- **`substitutes`**: `[MBomSubstitute]` **Arguments:** - `filters`: `MBomSubstituteInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MbomItem($id: ID!) { mbomItem(id: $id) { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomItem": { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } } } ``` # mbomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/queries/mbomItemReferenceDesignator Retrieves an item by its ID. **query** `mbomItemReferenceDesignator(id: ID!): MBomItemReferenceDesignator` ## Arguments **`id`**: `ID!` (required) ## Returns `MBomItemReferenceDesignator` **`LastSessionId`**: `String` --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReferenceDesignatorAssignmentsCount`**: `Int` Optimized count of referenceDesignatorAssignments. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomItemReferenceDesignatorEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String!` ## Examples ```graphql Query query MbomItemReferenceDesignator($id: ID!) { mbomItemReferenceDesignator(id: $id) { LastSessionId _BuildRequirementReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _created _etag } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomItemReferenceDesignator": { "LastSessionId": "string", "_BuildRequirementReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_created": "value", "_etag": "string" } } } ``` # mbomItemReferenceDesignators Source: https://docs.firstresonance.io/api-reference/queries/mbomItemReferenceDesignators Retrieves a list of items. **query** `mbomItemReferenceDesignators(after: String, before: String, distinctOn: [MBomItemReferenceDesignatorSortEnum], filters: MBomItemReferenceDesignatorsInputFilters, first: Int, last: Int, sort: [MBomItemReferenceDesignatorSortEnum]): MBomItemReferenceDesignatorsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomItemReferenceDesignatorSortEnum]` --- **`filters`**: `MBomItemReferenceDesignatorsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomItemReferenceDesignatorSortEnum]` ## Returns `MBomItemReferenceDesignatorsConnection` **`edges`**: `[MBomItemReferenceDesignatorsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomItemReferenceDesignators { mbomItemReferenceDesignators { edges { cursor node { LastSessionId _BuildRequirementReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _created _etag } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomItemReferenceDesignators": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_BuildRequirementReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_created": "value", "_etag": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomItems Source: https://docs.firstresonance.io/api-reference/queries/mbomItems Retrieves a list of items. **query** `mbomItems(after: String, before: String, distinctOn: [MBomItemSortEnum], filters: MBomItemsInputFilters, first: Int, last: Int, sort: [MBomItemSortEnum]): MBomItemsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomItemSortEnum]` --- **`filters`**: `MBomItemsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomItemSortEnum]` ## Returns `MBomItemsConnection` **`edges`**: `[MBomItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomItems { mbomItems { edges { cursor node { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomItems": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mbomSubstitute Source: https://docs.firstresonance.io/api-reference/queries/mbomSubstitute Retrieves an item by its ID. **query** `mbomSubstitute(id: ID!): MBomSubstitute` ## Arguments **`id`**: `ID!` (required) ## Returns `MBomSubstitute` **`LastSessionId`**: `String` --- **`_BuildRequirementSubstitutesCount`**: `Int` Optimized count of buildRequirementSubstitutes. --- **`_ParentCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirementSubstitutes`**: `[BuildRequirementSubstitute]` **Arguments:** - `filters`: `BuildRequirementSubstitutesInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int!` --- **`parent`**: `Part` --- **`parentId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomSubstituteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MbomSubstitute($id: ID!) { mbomSubstitute(id: $id) { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mbomSubstitute": { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # mbomSubstitutes Source: https://docs.firstresonance.io/api-reference/queries/mbomSubstitutes Retrieves a list of items. **query** `mbomSubstitutes(after: String, before: String, distinctOn: [MBomSubstituteSortEnum], filters: MBomSubstituteInputFilters, first: Int, last: Int, sort: [MBomSubstituteSortEnum]): MBomSubstitutesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomSubstituteSortEnum]` --- **`filters`**: `MBomSubstituteInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomSubstituteSortEnum]` ## Returns `MBomSubstitutesConnection` **`edges`**: `[MBomSubstitutesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MbomSubstitutes { mbomSubstitutes { edges { cursor node { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mbomSubstitutes": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # mboms Source: https://docs.firstresonance.io/api-reference/queries/mboms Retrieves a list of items. **query** `mboms(after: String, before: String, distinctOn: [MBomSortEnum], filters: MBomsInputFilters, first: Int, last: Int, sort: [MBomSortEnum]): MBomsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MBomSortEnum]` --- **`filters`**: `MBomsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MBomSortEnum]` ## Returns `MBomsConnection` **`edges`**: `[MBomsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Mboms { mboms { edges { cursor node { Attributes { __typename } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mboms": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "MbomAttribute" } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # me Source: https://docs.firstresonance.io/api-reference/queries/me Retrieves the currently authenticated user. **query** `me: User` ## Returns `User` **`LastSessionId`**: `String` --- **`Organization`**: `Organization` > Deprecated: Use `organization` instead, `Organization` is deprecated. --- **`_ActiveSessionsCount`**: `Int` Optimized count of active sessions. --- **`_AnalyticsCredentialCount`**: `Int` Optimized count of analyticsCredential. --- **`_ApiKeysCount`**: `Int` Optimized count of apiKeys. --- **`_PermissionGroupsCount`**: `Int` Optimized count of permissionGroups. --- **`_RolesCount`**: `Int` Optimized count of Roles. --- **`_TeamsCount`**: `Int` Optimized count of teams. --- **`_UpdatedByCount`**: `Int` Optimized count of updatedBy. --- **`_UserRolesCount`**: `Int` Optimized count of userRoles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`activeSessions`**: `[Session]` **Arguments:** - `filters`: `SessionsInputFilters` --- **`avatar`**: `String` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`deactivated`**: `Boolean!` --- **`email`**: `String` --- **`enforceMfa`**: `Boolean!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`ionBot`**: `Boolean!` --- **`isAdmin`**: `Boolean` --- **`lastLogin`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`name`**: `String` --- **`notificationEmailsEnabled`**: `Boolean!` --- **`organization`**: `Organization` --- **`organizationId`**: `Int!` --- **`permissionGroups`**: `[PermissionGroup]` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`teams`**: `[Team]` **Arguments:** - `filters`: `TeamsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserEventFilter` --- **`updatedBy`**: `[User]` --- **`updatedById`**: `Int` --- **`userRoles`**: `[UserRole]` **Arguments:** - `filters`: `UserRolesInputFilters` ## Examples ```graphql Query query Me { me { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } ``` ```json Response { "data": { "me": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } ``` # mrpJob Source: https://docs.firstresonance.io/api-reference/queries/mrpJob Retrieves an item by its ID. **query** `mrpJob(id: ID!): MRPJob` ## Arguments **`id`**: `ID!` (required) ## Returns `MRPJob` **`LastSessionId`**: `String` --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`endTime`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`failedReason`**: `String` --- **`id`**: `Int!` --- **`isLatest`**: `Boolean` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`startTime`**: `DateTime` --- **`status`**: `Jobstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MRPJobEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query MrpJob($id: ID!) { mrpJob(id: $id) { LastSessionId _CommentsCount _PlanItemsCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "mrpJob": { "LastSessionId": "string", "_CommentsCount": 1, "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # mrpJobs Source: https://docs.firstresonance.io/api-reference/queries/mrpJobs Retrieves a list of items. **query** `mrpJobs(after: String, before: String, distinctOn: [MRPJobSortEnum], filters: MRPJobsInputFilters, first: Int, last: Int, sort: [MRPJobSortEnum]): MRPJobsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[MRPJobSortEnum]` --- **`filters`**: `MRPJobsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[MRPJobSortEnum]` ## Returns `MRPJobsConnection` **`edges`**: `[MRPJobsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query MrpJobs { mrpJobs { edges { cursor node { LastSessionId _CommentsCount _PlanItemsCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "mrpJobs": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_CommentsCount": 1, "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # organization Source: https://docs.firstresonance.io/api-reference/queries/organization Retrieves the organization's settings. **query** `organization(id: ID!): Organization` ## Arguments **`id`**: `ID!` (required) ## Returns `Organization` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`aiAccessEnabled`**: `Boolean` Whether this org may use AI: eligibility AND the org's own opt-in. This is the predicate services enforce, including for work with no user in scope. --- **`aiAccessEnabledForCurrentUser`**: `Boolean` Whether this org's AI settings permit the requesting user: eligibility AND the org's opt-in. Org-wide, so the same for every user. Read this instead of combining the parts yourself. Clients use it to hide AI surfaces; the enforcing boundary is kraftor, which refuses on the same predicate. --- **`aiConsentRequired`**: `Boolean` Whether enabling ION Intelligence now needs a fresh acceptance of the AI Terms of Service. True before the first acceptance, after a version bump, and after the org has turned AI off — consent authorises one activation, not every future one. Clients read this to decide whether to present the terms. --- **`aiEligible`**: `Boolean` Whether First Resonance has made this org eligible for ION Intelligence. Clients use this to decide whether to offer the opt-in control at all; an ineligible org has nothing to consent to. --- **`aiEnabled`**: `Boolean` Whether this org's admins have turned ION Intelligence on. Org-wide: everyone or nobody. Only half of access — First Resonance must also have made the org eligible. --- **`allowWipOspKitting`**: `Boolean!` --- **`auth0Domain`**: `String` Auth0 tenant domain for token endpoint. --- **`auth0OrgId`**: `String` --- **`authField`**: `String` --- **`avatar`**: `String` --- **`branding`**: `OrganizationBrandingType` Branding settings for the organization's Auth0 login page. --- **`createdByApiClient`**: `ApiClientAttribution` --- **`domain`**: `String!` --- **`enableInventoryDisposition`**: `Boolean!` --- **`enforceCanHoldInventory`**: `Boolean!` --- **`enforcePickable`**: `Boolean!` --- **`enforcePlanReservations`**: `Boolean!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String` --- **`oauthApps`**: `[OAuthAppRegistrationObject]` Registered OAuth applications for this organization. --- **`oauthEnabled`**: `Boolean` Whether OAuth app registration is available in this environment. --- **`orgSchema`**: `String!` --- **`proceduresRoleBasedApprovalEnabled`**: `Boolean` Whether role-based procedure approvals are active for this org (vs the legacy reviewer-count model). --- **`settings`**: `OrganizationSettings` --- **`settingsStructured`**: `String` --- **`ssoConnectionId`**: `String` --- **`ssoProviderType`**: `String` --- **`users`**: `[User]` ## Examples ```graphql Query query Organization($id: ID!) { organization(id: $id) { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true } } } ``` # organizationDomain Source: https://docs.firstresonance.io/api-reference/queries/organizationDomain Retrieves an item by its ID. **query** `organizationDomain(id: ID!): OrganizationDomain` ## Arguments **`id`**: `ID!` (required) ## Returns `OrganizationDomain` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`auth0DomainId`**: `String!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`domain`**: `String!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`status`**: `DomainStatusEnum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `OrganizationDomainEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`verificationHost`**: `String` --- **`verificationToken`**: `String!` --- **`verifiedAt`**: `DateTime` ## Examples ```graphql Query query OrganizationDomain($id: ID!) { organizationDomain(id: $id) { LastSessionId _created _etag _updated auth0DomainId createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "organizationDomain": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0DomainId": "string", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # organizationDomains Source: https://docs.firstresonance.io/api-reference/queries/organizationDomains Retrieves a list of items. **query** `organizationDomains(after: String, before: String, distinctOn: [OrganizationDomainSortEnum], filters: OrganizationDomainsInputFilters, first: Int, last: Int, sort: [OrganizationDomainSortEnum]): OrganizationDomainsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[OrganizationDomainSortEnum]` --- **`filters`**: `OrganizationDomainsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[OrganizationDomainSortEnum]` ## Returns `OrganizationDomainsConnection` **`edges`**: `[OrganizationDomainsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query OrganizationDomains { organizationDomains { edges { cursor node { LastSessionId _created _etag _updated auth0DomainId createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "organizationDomains": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "auth0DomainId": "string", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # part Source: https://docs.firstresonance.io/api-reference/queries/part Retrieves an item by its ID. **query** `part(id: ID!): Part` ## Arguments **`id`**: `ID!` (required) ## Returns `Part` **`Attributes`**: `[PartAttribute]` **Arguments:** - `filters`: `PartAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`LatestRevisionScheme`**: `String` --- **`MbomItemSubstitutes`**: `[MBomSubstitute]` **Arguments:** - `filters`: `MBomSubstituteInputFilters` --- **`MbomItems`**: `[MBomItem]` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`SubstituteMbom`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BuildRequirementSubstitutesCount`**: `Int` Optimized count of buildRequirementSubstitutes. --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FurtherActionsCount`**: `Int` Optimized count of furtherActions. --- **`_InputsCount`**: `Int` Optimized count of inputs. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MbomItemSubstitutesCount`**: `Int` Optimized count of MbomItemSubstitutes. --- **`_MbomItemsCount`**: `Int` Optimized count of MbomItems. --- **`_MbomsCount`**: `Int` Optimized count of mboms. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_PartProceduresCount`**: `Int` Optimized count of partProcedures. --- **`_PartSubtypesCount`**: `Int` Optimized count of partSubtypes. --- **`_PartsInventoryCount`**: `Int` Optimized count of partsInventory. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_ProceduresCount`**: `Int` Optimized count of procedures. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_RequirementsCount`**: `Int` Optimized count of requirements. --- **`_RevisionsCount`**: `Int` Optimized count of revisions. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_SupplierPartsCount`**: `Int` Optimized count of supplierParts. --- **`_UnitOfMeasureConflictsCount`**: `Int` Optimized count of unitOfMeasureConflicts. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[PartAttributedPart]` **Arguments:** - `filters`: `PartAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartAttributedUser]` **Arguments:** - `filters`: `PartAttributedUsersInputFilters` --- **`attributes`**: `[PartAttribute]` --- **`buildRequirementSubstitutes`**: `[BuildRequirementSubstitute]` **Arguments:** - `filters`: `BuildRequirementSubstitutesInputFilters` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`comments`**: `[Comment]` --- **`cost`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`demandTotal`**: `Float` --- **`description`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`exportControlled`**: `Boolean` --- **`fileAttachments`**: `[FileAttachment]` --- **`furtherActions`**: `[FurtherAction]` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`hasInventory`**: `Boolean!` True when part.purchaseType is RECEIVABLE_INVENTORY. > Deprecated: Use purchaseType instead. --- **`id`**: `Int!` --- **`independentDemandTotal`**: `Float` --- **`inputs`**: `[PlanInput]` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` --- **`isLatestRevision`**: `Boolean` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`latestMbom`**: `MBom` --- **`latestReleasedMbom`**: `MBom` --- **`latestReleasedMbomWithFallback`**: `MBom` --- **`latestRevision`**: `String` --- **`leadTime`**: `Int` --- **`maintenanceIntervalSeconds`**: `Int` --- **`mbom`**: `[MBomItem]` --- **`mboms`**: `[MBom]` **Arguments:** - `filters`: `MBomsInputFilters` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partNumber`**: `String!` --- **`partProcedures`**: `[PartProcedure]` **Arguments:** - `filters`: `PartProceduresInputFilters` --- **`partSubtypes`**: `[PartSubtype]` **Arguments:** - `filters`: `PartSubtypesInputFilters` --- **`partType`**: `Parttypeenum!` --- **`partsInventory`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`procedures`**: `[Procedure]` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseType`**: `purchasetypeenum` --- **`quantity`**: `Int` --- **`reorderMaximumQuantity`**: `Float` --- **`reorderMinimumQuantity`**: `Float` --- **`requirements`**: `[Requirement]` --- **`revisedFrom`**: `Part` --- **`revisedFromId`**: `Int` --- **`revision`**: `String!` --- **`revisionScheme`**: `String` --- **`revisions`**: `[Part]` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`sourcingStrategy`**: `Sourcingstrategyenum` --- **`status`**: `Partstatusenum!` --- **`supplierPartNumber`**: `String` Use supplierPartNumber on SupplierParts instead. > Deprecated: Supplier part number has moved to SupplierParts. --- **`supplierParts`**: `[SupplierPart]` **Arguments:** - `filters`: `SupplierPartsInputFilters` --- **`surplusTotal`**: `Float` --- **`thumbnail`**: `FileAttachment` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`thumbnailId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartEventFilter` --- **`trackingType`**: `Trackingtypeenum` --- **`unitOfMeasure`**: `UnitOfMeasurement` **Arguments:** - `filters`: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureConflicts`**: `[PartUnitOfMeasureConflict]` --- **`unitOfMeasureId`**: `Int!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Part($id: ID!) { part(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId LatestRevisionScheme MbomItemSubstitutes { LastSessionId _BuildRequirementSubstitutesCount _ParentCount _created _etag _updated } MbomItems { LastSessionId _BuildRequirementsCount _ParentCount _PartKitItemsCount _ProcedureMbomItemsCount _ReferenceDesignatorsCount } SubstituteMbom } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "part": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "LastSessionId": "string", "_BuildRequirementSubstitutesCount": 1, "_ParentCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "MbomItems": [ { "LastSessionId": "string", "_BuildRequirementsCount": 1, "_ParentCount": 1, "_PartKitItemsCount": 1, "_ProcedureMbomItemsCount": 1, "_ReferenceDesignatorsCount": 1 } ], "SubstituteMbom": "string" } } } ``` # partInventories Source: https://docs.firstresonance.io/api-reference/queries/partInventories Retrieves a list of items. **query** `partInventories(after: String, before: String, distinctOn: [PartInventorySortEnum], filters: PartInventoriesInputFilters, first: Int, last: Int, sort: [PartInventorySortEnum]): PartInventoriesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartInventorySortEnum]` --- **`filters`**: `PartInventoriesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartInventorySortEnum]` ## Returns `PartInventoriesConnection` **`aggregates`**: `AggregatesField!` --- **`edges`**: `[PartInventoriesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartInventories { partInventories { aggregates { count sum { quantity quantityAvailable } } edges { cursor node { Attributes { __typename } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partInventories": { "aggregates": { "count": 1, "sum": { "quantity": 1.5, "quantityAvailable": 1.5 } }, "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PartInventoryAttribute" } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partInventory Source: https://docs.firstresonance.io/api-reference/queries/partInventory Retrieves an item by its ID. **query** `partInventory(id: ID!): PartInventory` ## Arguments **`id`**: `ID!` (required) ## Returns `PartInventory` **`Attributes`**: `[PartInventoryAttribute]` **Arguments:** - `filters`: `PartInventoryAttributesInputFilters` --- **`Cost`**: `Float` --- **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_InstalledOnBuildRequirementCount`**: `Int` Optimized count of installedOnBuildRequirement. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MadeOnAssemblyChildPartInventoriesCount`**: `Int` Optimized count of madeOnAssemblyChildPartInventories. --- **`_MbomChangesCount`**: `Int` Optimized count of mbomChanges. --- **`_OriginRunsCount`**: `Int` Optimized count of originRuns. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of partKitInventories. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_PartKitsCount`**: `Int` --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_ReceiptsCount`**: `Int` Optimized count of receipts. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `Int!` --- **`activeKitId`**: `Int` The most recent active kit that the part inventory is in. --- **`attributedParts`**: `[PartInventoryAttributedPart]` **Arguments:** - `filters`: `PartInventoryAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartInventoryAttributedUser]` **Arguments:** - `filters`: `PartInventoryAttributedUsersInputFilters` --- **`attributes`**: `[PartInventoryAttribute]` --- **`awaitingReview`**: `Boolean!` True while this inventory awaits human review; status derives to needs_review until a review resolution or lifecycle event clears it. --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`canceledPoLinesCount`**: `Int!` --- **`comments`**: `[Comment]` --- **`cost`**: `Float` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrival`**: `DateTime` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`estimatedTotalCost`**: `Float` --- **`failedRunsCount`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`howCreated`**: `InventoryEventType` --- **`howLastSplit`**: `InventoryEventType` --- **`id`**: `Int!` --- **`identifiable`**: `Boolean` True if the inventory has a serial number, lot number, or location. This is used to determine if an inventory can be deleted when used on a purchase order line and the line is canceled. --- **`identity`**: `String` --- **`installed`**: `Boolean` True if the inventory's full quantity is installed onto a parent part. --- **`installedOnBuildRequirement`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`installedPartInventories`**: `[PartInventory]` --- **`installs`**: `[ABomInstallation]` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isLinkedToOspPoLine`**: `Boolean` True if this inventory is linked to a PO line via an outside processing (OSP) run step: the linking record has a run step set and that run step is marked as outside processing. Used to allow kitting of WIP inventory for OSP. --- **`isLocationAvailable`**: `Boolean!` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`kitted`**: `Boolean` True if the inventory's full quantity is actively kitted. --- **`labels`**: `[Label]` --- **`lastMaintainedDate`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`lotNumber`**: `String` --- **`madeOnAssemblyChildPartInventories`**: `[PartInventory]` --- **`madeOnAssemblyParentPartInventory`**: `PartInventory` --- **`madeOnAssemblyParentPartInventoryId`**: `Int` --- **`maintenanceStatus`**: `MaintenanceStatus` --- **`mbomChanges`**: `[MbomChangeOrderLine]` Every mBOM change this unit has gone through (applied, in progress, and canceled), oldest first. --- **`mergeCandidateIds`**: `[Int]` --- **`mergeCandidateIdsV2`**: `[Int]` --- **`needDate`**: `DateTime` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`openPoLinesCount`**: `Int!` --- **`openRunsCount`**: `Int!` --- **`originMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`originMbomId`**: `Int` --- **`originPartInventory`**: `PartInventory` --- **`originPartInventoryId`**: `Int` --- **`originRuns`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`parentLocations`**: `[Location]` --- **`parentPartInventories`**: `[PartInventory]` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[PartInventory]` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKits`**: `[PartKit]` Part kits that this inventory is kitted to. --- **`percentAbomInstalled`**: `Int` Percent of build requirements that are fulfilled. Each build requirement is given an equal weight in the calculation. --- **`poLinesCount`**: `Int!` --- **`prettyStr`**: `String` --- **`projectedReleaseStatus`**: `InventoryStatus` The status this inventory would re-derive to if its review were resolved as release. Null unless awaiting review. --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`qualityHoldsCount`**: `Int!` --- **`quantity`**: `Float!` --- **`quantityAvailable`**: `Float` Quantity available that is ready to be consumed. This is the quantity that is not in wip, kitted, installed, or scrapped. --- **`quantityInstalled`**: `Float` Quantity installed onto parent parts. --- **`quantityIssued`**: `Float` See quantity_kitted for more info. > Deprecated: This was replaced by quantity_kitted. --- **`quantityKitted`**: `Float` Quantity kitted to open kits. Open means that the kit status is not complete or canceled. --- **`quantityNotScrapped`**: `String` --- **`quantityScrapped`**: `Float!` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receipts`**: `[Receipt]` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`received`**: `Boolean` True if the inventory's full quantity is received. --- **`receivedOrCreatedDate`**: `DateTime!` --- **`receivedPoLinesCount`**: `Int!` --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`serialNumber`**: `String` --- **`serviceDueDate`**: `DateTime` --- **`status`**: `InventoryStatus` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartInventoryEventFilter` --- **`trackingType`**: `Trackingtypeenum` The tracking type defined by the inventory. For instance, if a serial number is populated on the inventory, this will be 'serial'. --- **`unavailable`**: `Boolean!` --- **`unitOfMeasure`**: `UnitOfMeasurement` **Arguments:** - `filters`: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureId`**: `Int` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`uri`**: `String` --- **`usageType`**: `String` ## Examples ```graphql Query query PartInventory($id: ID!) { partInventory(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "partInventory": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } ``` # partInventoryBuildRequirement Source: https://docs.firstresonance.io/api-reference/queries/partInventoryBuildRequirement Retrieves an item by its ID. **query** `partInventoryBuildRequirement(buildRequirementId: ID!, partInventoryId: ID!): PartInventoryBuildRequirement` ## Arguments **`buildRequirementId`**: `ID!` (required) --- **`partInventoryId`**: `ID!` (required) ## Returns `PartInventoryBuildRequirement` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` Return the build_requirement relationship. **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`partInventory`**: `PartInventory` Return the part_inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartInventoryBuildRequirementEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PartInventoryBuildRequirement($buildRequirementId: ID!, $partInventoryId: ID!) { partInventoryBuildRequirement(buildRequirementId: $buildRequirementId, partInventoryId: $partInventoryId) { LastSessionId _created _etag _updated buildRequirement { LastSessionId _AbomInstallationsCount _AcceptablePartsCount _BuildRequirementReferenceDesignatorsCount _BuildRequirementSubstitutesCount _InstalledPartInventoriesCount } buildRequirementId } } ``` ```json Variables { "buildRequirementId": "id", "partInventoryId": "id" } ``` ```json Response { "data": { "partInventoryBuildRequirement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AcceptablePartsCount": 1, "_BuildRequirementReferenceDesignatorsCount": 1, "_BuildRequirementSubstitutesCount": 1, "_InstalledPartInventoriesCount": 1 }, "buildRequirementId": 1 } } } ``` # partInventoryBuildRequirements Source: https://docs.firstresonance.io/api-reference/queries/partInventoryBuildRequirements Retrieves a list of items. **query** `partInventoryBuildRequirements(after: String, before: String, distinctOn: [PartInventoryBuildRequirementSortEnum], filters: PartInventoryBuildRequirementsInputFilters, first: Int, last: Int, sort: [PartInventoryBuildRequirementSortEnum]): PartInventoryBuildRequirementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartInventoryBuildRequirementSortEnum]` --- **`filters`**: `PartInventoryBuildRequirementsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartInventoryBuildRequirementSortEnum]` ## Returns `PartInventoryBuildRequirementsConnection` **`edges`**: `[PartInventoryBuildRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartInventoryBuildRequirements { partInventoryBuildRequirements { edges { cursor node { LastSessionId _created _etag _updated buildRequirement { __typename } buildRequirementId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partInventoryBuildRequirements": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "buildRequirement": { "__typename": "BuildRequirement" }, "buildRequirementId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partInventoryHistory Source: https://docs.firstresonance.io/api-reference/queries/partInventoryHistory **query** `partInventoryHistory(after: String, before: String, filters: PartInventoryHistoryInputFilters, first: Int, last: Int, subjectId: Int!): PartInventoryHistoryConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`filters`**: `PartInventoryHistoryInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`subjectId`**: `Int!` (required) ## Returns `PartInventoryHistoryConnection` **`edges`**: `[PartInventoryHistoryEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartInventoryHistory($subjectId: Int!) { partInventoryHistory(subjectId: $subjectId) { edges { cursor node { actions { __typename } id subjectId transactionId tstamp user { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Variables { "subjectId": 1 } ``` ```json Response { "data": { "partInventoryHistory": { "edges": [ { "cursor": "string", "node": { "actions": [ { "__typename": "PartInventoryHistoryAction" } ], "id": "id", "subjectId": 1, "transactionId": 1, "tstamp": "value", "user": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partKit Source: https://docs.firstresonance.io/api-reference/queries/partKit Retrieves an item by its ID. **query** `partKit(id: ID!): PartKit` ## Arguments **`id`**: `ID!` (required) ## Returns `PartKit` **`Attributes`**: `[PartKitAttribute]` **Arguments:** - `filters`: `PartKitAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of part kit inventories. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[PartKitAttributedPart]` **Arguments:** - `filters`: `PartKitAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartKitAttributedUser]` **Arguments:** - `filters`: `PartKitAttributedUsersInputFilters` --- **`attributes`**: `[PartKitAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deliveryLocation`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`deliveryLocationId`**: `Int` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`fillabilityPercent`**: `Int` Share of this kit's remaining need the pick list can allocate, 0-100. Scored for this kit alone: kits picked together in one run share inventory, so a batch can allocate less than the individual scores suggest, and a pick scoped to a locationId can fill less still since this counts stock in every location. Advisory - recalculated when its inputs change, so a concurrent transaction can consume stock this score still counts. The pick list is the authority at allocation time. --- **`fulfilled`**: `Boolean` --- **`id`**: `Int!` --- **`isFullyFillable`**: `Boolean` Whether the pick list can fully allocate this kit's remaining need, scored for this kit alone (see fillabilityPercent). --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`partInventories`**: `[IssuedPartInventory]` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`percentFulfilled`**: `Int` --- **`percentKitted`**: `Int` --- **`prettyStr`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int` --- **`status`**: `Partkitstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartKitEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PartKit($id: ID!) { partKit(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "partKit": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } } ``` # partKitInventories Source: https://docs.firstresonance.io/api-reference/queries/partKitInventories Retrieves a list of items. **query** `partKitInventories(after: String, before: String, distinctOn: [PartKitInventorySortEnum], filters: PartKitInventoriesInputFilters, first: Int, last: Int, sort: [PartKitInventorySortEnum]): PartKitInventorysConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartKitInventorySortEnum]` --- **`filters`**: `PartKitInventoriesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartKitInventorySortEnum]` ## Returns `PartKitInventorysConnection` **`edges`**: `[PartKitInventorysEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartKitInventories { partKitInventories { edges { cursor node { _MbomItemsCount _created _etag _updated id locationId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partKitInventories": { "edges": [ { "cursor": "string", "node": { "_MbomItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "id": "id", "locationId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partKitInventory Source: https://docs.firstresonance.io/api-reference/queries/partKitInventory Retrieves an item by its ID. **query** `partKitInventory(partInventoryId: ID!, partKitItemId: ID!): PartKitInventory` ## Arguments **`partInventoryId`**: `ID!` (required) --- **`partKitItemId`**: `ID!` (required) ## Returns `PartKitInventory` **`_MbomItemsCount`**: `Int` Optimized count of mbom items. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`id`**: `ID` --- **`locationId`**: `Int` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`partKit`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`partKitItem`**: `PartKitItem` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKitItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` ## Examples ```graphql Query query PartKitInventory($partInventoryId: ID!, $partKitItemId: ID!) { partKitInventory(partInventoryId: $partInventoryId, partKitItemId: $partKitItemId) { _MbomItemsCount _created _etag _updated id locationId } } ``` ```json Variables { "partInventoryId": "id", "partKitItemId": "id" } ``` ```json Response { "data": { "partKitInventory": { "_MbomItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "id": "id", "locationId": 1 } } } ``` # partKitItem Source: https://docs.firstresonance.io/api-reference/queries/partKitItem Retrieves an item by its ID. **query** `partKitItem(id: ID!): PartKitItem` ## Arguments **`id`**: `ID!` (required) ## Returns `PartKitItem` **`Attributes`**: `[PartKitItemAttribute]` **Arguments:** - `filters`: `PartKitItemAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of partKitInventories. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`acceptablePartIds`**: `[PartKitItemAcceptablePart]` --- **`attributedParts`**: `[PartKitItemAttributedPart]` **Arguments:** - `filters`: `PartKitItemAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartKitItemAttributedUser]` **Arguments:** - `filters`: `PartKitItemAttributedUsersInputFilters` --- **`attributes`**: `[PartKitItemAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`firstInventoryDisplay`**: `String` Get first inventory to display on Kitting page. This is not very performant and should only be used on the Kitting page. **Arguments:** - `includeOnOrder`: `Boolean!` --- **`fulfilled`**: `Boolean` --- **`id`**: `Int!` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`originMbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`originMbomItemId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[IssuedPartInventory]` --- **`partKit`**: `PartKit` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`partKitId`**: `Int` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`quantityFulfilled`**: `Float` --- **`quantityUnfulfilled`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartKitItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PartKitItem($id: ID!) { partKitItem(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "partKitItem": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } ``` # partKitItems Source: https://docs.firstresonance.io/api-reference/queries/partKitItems Retrieves a list of items. **query** `partKitItems(after: String, before: String, distinctOn: [PartKitItemSortEnum], filters: PartKitItemsInputFilters, first: Int, last: Int, sort: [PartKitItemSortEnum]): PartKitItemsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartKitItemSortEnum]` --- **`filters`**: `PartKitItemsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartKitItemSortEnum]` ## Returns `PartKitItemsConnection` **`edges`**: `[PartKitItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartKitItems { partKitItems { edges { cursor node { Attributes { __typename } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partKitItems": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PartKitItemAttribute" } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partKitPickList Source: https://docs.firstresonance.io/api-reference/queries/partKitPickList Generates a pick list for a part kit(s) based on a specified strategy. Use partKitIds for multi-kit batches (preferred), or partKitId for single-kit legacy support. **query** `partKitPickList(locationId: Int, partKitId: Int, partKitIds: [ID!], pickStrategy: PickListStrategy!): PartKitPickList` ## Arguments **`locationId`**: `Int` --- **`partKitId`**: `Int` --- **`partKitIds`**: `[ID!]` --- **`pickStrategy`**: `PickListStrategy!` (required) ## Returns `PartKitPickList` **`locations`**: `[PartKitPickListLocation]` --- **`partInventories`**: `[PartInventory]` ## Examples ```graphql Query query PartKitPickList($pickStrategy: PickListStrategy!) { partKitPickList(pickStrategy: $pickStrategy) { locations { inventoryRows { inventory { __typename } inventoryId kitAllocations { __typename } partId quantityToPull } locationId locationName stopNumber } partInventories { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } } ``` ```json Variables { "pickStrategy": "FIFO" } ``` ```json Response { "data": { "partKitPickList": { "locations": [ { "inventoryRows": [ { "inventory": { "__typename": "PartInventory" }, "inventoryId": "id", "kitAllocations": [ { "__typename": "PartKitAllocation" } ], "partId": "id", "quantityToPull": 1.5 } ], "locationId": "id", "locationName": "string", "stopNumber": 1 } ], "partInventories": [ { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } ] } } } ``` # partKits Source: https://docs.firstresonance.io/api-reference/queries/partKits Retrieves a list of items. **query** `partKits(after: String, before: String, customAttributeSort: CustomAttributeSortInput, distinctOn: [PartKitSortEnum], filters: PartKitsInputFilters, first: Int, last: Int, sort: [PartKitSortEnum]): PartKitsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`customAttributeSort`**: `CustomAttributeSortInput` --- **`distinctOn`**: `[PartKitSortEnum]` --- **`filters`**: `PartKitsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartKitSortEnum]` ## Returns `PartKitsConnection` **`edges`**: `[PartKitsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartKits { partKits { edges { cursor node { Attributes { __typename } LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount _AttributesCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partKits": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PartKitAttribute" } ], "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partProcedure Source: https://docs.firstresonance.io/api-reference/queries/partProcedure Retrieves an item by its ID. **query** `partProcedure(partId: ID!, procedureId: ID!): PartProcedure` ## Arguments **`partId`**: `ID!` (required) --- **`procedureId`**: `ID!` (required) ## Returns `PartProcedure` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `ID!` --- **`pinnedMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`pinnedMbomId`**: `Int` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `ID!` --- **`required`**: `Boolean!` --- **`status`**: `partprocedurestatusreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartProcedureEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PartProcedure($partId: ID!, $procedureId: ID!) { partProcedure(partId: $partId, procedureId: $procedureId) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdById } } ``` ```json Variables { "partId": "id", "procedureId": "id" } ``` ```json Response { "data": { "partProcedure": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdById": 1 } } } ``` # partProcedures Source: https://docs.firstresonance.io/api-reference/queries/partProcedures Retrieves a list of items. **query** `partProcedures(after: String, before: String, distinctOn: [PartProcedureSortEnum], filters: PartProceduresInputFilters, first: Int, last: Int, sort: [PartProcedureSortEnum]): PartProceduresConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartProcedureSortEnum]` --- **`filters`**: `PartProceduresInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartProcedureSortEnum]` ## Returns `PartProceduresConnection` **`edges`**: `[PartProceduresEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartProcedures { partProcedures { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partProcedures": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # partSubtype Source: https://docs.firstresonance.io/api-reference/queries/partSubtype Retrieves an item by its ID. **query** `partSubtype(id: ID!): PartSubtype` ## Arguments **`id`**: `ID!` (required) ## Returns `PartSubtype` **`LastSessionId`**: `String` --- **`_PartsCount`**: `Int` Optimized count of parts. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`parts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartSubtypeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PartSubtype($id: ID!) { partSubtype(id: $id) { LastSessionId _PartsCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "partSubtype": { "LastSessionId": "string", "_PartsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # partSubtypes Source: https://docs.firstresonance.io/api-reference/queries/partSubtypes Retrieves a list of items. **query** `partSubtypes(after: String, before: String, distinctOn: [PartSubtypeSortEnum], filters: PartSubtypesInputFilters, first: Int, last: Int, sort: [PartSubtypeSortEnum]): PartSubtypesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartSubtypeSortEnum]` --- **`filters`**: `PartSubtypesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartSubtypeSortEnum]` ## Returns `PartSubtypesConnection` **`edges`**: `[PartSubtypesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PartSubtypes { partSubtypes { edges { cursor node { LastSessionId _PartsCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "partSubtypes": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_PartsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # parts Source: https://docs.firstresonance.io/api-reference/queries/parts Retrieves a list of items. **query** `parts(after: String, before: String, distinctOn: [PartSortEnum], filters: PartsInputFilters, first: Int, last: Int, sort: [PartSortEnum]): PartsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PartSortEnum]` --- **`filters`**: `PartsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PartSortEnum]` ## Returns `PartsConnection` **`edges`**: `[PartsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Parts { parts { edges { cursor node { Attributes { __typename } LastSessionId LatestRevisionScheme MbomItemSubstitutes { __typename } MbomItems { __typename } SubstituteMbom } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "parts": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PartAttribute" } ], "LastSessionId": "string", "LatestRevisionScheme": "string", "MbomItemSubstitutes": [ { "__typename": "MBomSubstitute" } ], "MbomItems": [ { "__typename": "MBomItem" } ], "SubstituteMbom": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # permissionGroup Source: https://docs.firstresonance.io/api-reference/queries/permissionGroup Retrieves an item by its ID. **query** `permissionGroup(id: ID!): PermissionGroup` ## Arguments **`id`**: `ID!` (required) ## Returns `PermissionGroup` **`_RolesCount`**: `Int` Optimized count of roles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`family`**: `String!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PermissionGroupEventFilter` ## Examples ```graphql Query query PermissionGroup($id: ID!) { permissionGroup(id: $id) { _RolesCount _created _etag _updated createdByApiClient { id name } family } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "permissionGroup": { "_RolesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdByApiClient": { "id": 1, "name": "string" }, "family": "string" } } } ``` # permissionGroups Source: https://docs.firstresonance.io/api-reference/queries/permissionGroups Retrieves a list of items. **query** `permissionGroups(after: String, before: String, distinctOn: [PermissionGroupSortEnum], filters: PermissionGroupsInputFilters, first: Int, last: Int, sort: [PermissionGroupSortEnum]): PermissionGroupsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PermissionGroupSortEnum]` --- **`filters`**: `PermissionGroupsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PermissionGroupSortEnum]` ## Returns `PermissionGroupsConnection` **`edges`**: `[PermissionGroupsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PermissionGroups { permissionGroups { edges { cursor node { _RolesCount _created _etag _updated createdByApiClient { __typename } family } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "permissionGroups": { "edges": [ { "cursor": "string", "node": { "_RolesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdByApiClient": { "__typename": "ApiClientAttribution" }, "family": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # pickOverrideEvents Source: https://docs.firstresonance.io/api-reference/queries/pickOverrideEvents Retrieves a list of items. **query** `pickOverrideEvents(after: String, before: String, distinctOn: [PickOverrideEventSortEnum], filters: PickOverrideEventsInputFilters, first: Int, last: Int, sort: [PickOverrideEventSortEnum]): PickOverrideEventsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PickOverrideEventSortEnum]` --- **`filters`**: `PickOverrideEventsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PickOverrideEventSortEnum]` ## Returns `PickOverrideEventsConnection` **`edges`**: `[PickOverrideEventsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PickOverrideEvents { pickOverrideEvents { edges { cursor node { _created _updated chosenLocationId chosenPartId chosenPartInventoryId createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "pickOverrideEvents": { "edges": [ { "cursor": "string", "node": { "_created": "value", "_updated": "value", "chosenLocationId": 1, "chosenPartId": 1, "chosenPartInventoryId": 1, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # pickRunStopAllocations Source: https://docs.firstresonance.io/api-reference/queries/pickRunStopAllocations Retrieves a list of items. **query** `pickRunStopAllocations(after: String, before: String, distinctOn: [PickRunStopAllocationSortEnum], filters: PickRunStopAllocationsInputFilters, first: Int, last: Int, sort: [PickRunStopAllocationSortEnum]): PickRunStopAllocationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PickRunStopAllocationSortEnum]` --- **`filters`**: `PickRunStopAllocationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PickRunStopAllocationSortEnum]` ## Returns `PickRunStopAllocationsConnection` **`edges`**: `[PickRunStopAllocationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PickRunStopAllocations { pickRunStopAllocations { edges { cursor node { Created Etag LastSessionId Updated createdBy { __typename } createdById } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "pickRunStopAllocations": { "edges": [ { "cursor": "string", "node": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "createdBy": { "__typename": "User" }, "createdById": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # pickRunStops Source: https://docs.firstresonance.io/api-reference/queries/pickRunStops Retrieves a list of items. **query** `pickRunStops(after: String, before: String, distinctOn: [PickRunStopSortEnum], filters: PickRunStopsInputFilters, first: Int, last: Int, sort: [PickRunStopSortEnum]): PickRunStopsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PickRunStopSortEnum]` --- **`filters`**: `PickRunStopsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PickRunStopSortEnum]` ## Returns `PickRunStopsConnection` **`edges`**: `[PickRunStopsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PickRunStops { pickRunStops { edges { cursor node { Created Etag LastSessionId Updated _AllocationsCount allocations { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "pickRunStops": { "edges": [ { "cursor": "string", "node": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_AllocationsCount": 1, "allocations": [ { "__typename": "PickRunStopAllocation" } ] } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # pickRuns Source: https://docs.firstresonance.io/api-reference/queries/pickRuns Retrieves a list of items. **query** `pickRuns(after: String, before: String, distinctOn: [PickRunSortEnum], filters: PickRunsInputFilters, first: Int, last: Int, sort: [PickRunSortEnum]): PickRunsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PickRunSortEnum]` --- **`filters`**: `PickRunsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PickRunSortEnum]` ## Returns `PickRunsConnection` **`edges`**: `[PickRunsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PickRuns { pickRuns { edges { cursor node { Created Etag LastSessionId Updated _KitsCount _StopsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "pickRuns": { "edges": [ { "cursor": "string", "node": { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_KitsCount": 1, "_StopsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # plan Source: https://docs.firstresonance.io/api-reference/queries/plan Retrieves an item by its ID. **query** `plan(id: ID!): Plan` ## Arguments **`id`**: `ID!` (required) ## Returns `Plan` **`Attributes`**: `[PlanAttribute]` **Arguments:** - `filters`: `PlanAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_ConstraintsCount`**: `Int` Optimized count of constraints. --- **`_InputsCount`**: `Int` Optimized count of inputs. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[PlanAttributedPart]` **Arguments:** - `filters`: `PlanAttributedPartsInputFilters` --- **`attributedUsers`**: `[PlanAttributedUser]` **Arguments:** - `filters`: `PlanAttributedUsersInputFilters` --- **`attributes`**: `[PlanAttribute]` --- **`comments`**: `[Comment]` --- **`constraints`**: `[PlanConstraint]` **Arguments:** - `filters`: `PlanConstraintsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`includeInMrp`**: `Boolean!` --- **`inputs`**: `[PlanInput]` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`percentComplete`**: `Int` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`status`**: `Plansstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Plan($id: ID!) { plan(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "plan": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } ``` # planConstraint Source: https://docs.firstresonance.io/api-reference/queries/planConstraint Retrieves an item by its ID. **query** `planConstraint(id: ID!): PlanConstraint` ## Arguments **`id`**: `ID!` (required) ## Returns `PlanConstraint` **`LastSessionId`**: `String` --- **`_PlanConstraintLocationsCount`**: `Int` Optimized count of planConstraintLocations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`operator`**: `Constraintoperatorenum!` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planConstraintLocations`**: `[PlanConstraintLocation]` **Arguments:** - `filters`: `PlanConstraintLocationsInputFilters` --- **`planId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanConstraintEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PlanConstraint($id: ID!) { planConstraint(id: $id) { LastSessionId _PlanConstraintLocationsCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "planConstraint": { "LastSessionId": "string", "_PlanConstraintLocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # planConstraints Source: https://docs.firstresonance.io/api-reference/queries/planConstraints Retrieves a list of items. **query** `planConstraints(after: String, before: String, distinctOn: [PlanConstraintSortEnum], filters: PlanConstraintsInputFilters, first: Int, last: Int, sort: [PlanConstraintSortEnum]): PlanConstraintsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PlanConstraintSortEnum]` --- **`filters`**: `PlanConstraintsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PlanConstraintSortEnum]` ## Returns `PlanConstraintsConnection` **`edges`**: `[PlanConstraintsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PlanConstraints { planConstraints { edges { cursor node { LastSessionId _PlanConstraintLocationsCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "planConstraints": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_PlanConstraintLocationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # planInput Source: https://docs.firstresonance.io/api-reference/queries/planInput Retrieves an item by its ID. **query** `planInput(id: ID!): PlanInput` ## Arguments **`id`**: `ID!` (required) ## Returns `PlanInput` **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`completedQuantity`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`dueDate`**: `DateTime!` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `Int!` --- **`isGenerateNewDemand`**: `Boolean!` --- **`isIndependent`**: `Boolean!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`percentComplete`**: `String` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planId`**: `Int!` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`quantity`**: `Int!` --- **`serialNumber`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanInputEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PlanInput($id: ID!) { planInput(id: $id) { Deleted LastSessionId _PlanItemsCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "planInput": { "Deleted": true, "LastSessionId": "string", "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # planInputs Source: https://docs.firstresonance.io/api-reference/queries/planInputs Retrieves a list of items. **query** `planInputs(after: String, before: String, distinctOn: [PlanInputSortEnum], filters: PlanInputsInputFilters, first: Int, last: Int, sort: [PlanInputSortEnum]): PlanInputsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PlanInputSortEnum]` --- **`filters`**: `PlanInputsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PlanInputSortEnum]` ## Returns `PlanInputsConnection` **`edges`**: `[PlanInputsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PlanInputs { planInputs { edges { cursor node { Deleted LastSessionId _PlanItemsCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "planInputs": { "edges": [ { "cursor": "string", "node": { "Deleted": true, "LastSessionId": "string", "_PlanItemsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # planItem Source: https://docs.firstresonance.io/api-reference/queries/planItem Retrieves an item by its ID. **query** `planItem(id: ID!): PlanItem` ## Arguments **`id`**: `ID!` (required) ## Returns `PlanItem` **`LastSessionId`**: `String` --- **`_ChildAllocationsCount`**: `Int` Optimized count of childAllocations. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_InputsCount`**: `Int` Optimized count of inputs. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_ParentAllocationsCount`**: `Int` Optimized count of parentAllocations. --- **`_PartInventoriesCount`**: `Int` Optimized count of part inventory. --- **`_PlanInputsCount`**: `Int` Optimized count of plan inputs. --- **`_PlansCount`**: `Int` Optimized count of plans. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchase_order_lines. --- **`_ResultEntitiesCount`**: `Int` Optimized count of resultEntities. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`alteredFromAutoplan`**: `Boolean!` --- **`assignedTo`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` Declare assigned_to_id column. --- **`childAllocations`**: `[PlanItemAllocation]` **Arguments:** - `filters`: `PlanItemAllocationsInputFilters` --- **`clearToBuild`**: `Boolean` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`endTime`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`explode`**: `Boolean!` --- **`forecastedEndTime`**: `DateTime` --- **`forecastedStartTime`**: `DateTime` --- **`hasResults`**: `Boolean` --- **`id`**: `Int!` --- **`inputs`**: `[PlanInput]` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`isBlocked`**: `Boolean!` --- **`isFirm`**: `Boolean!` --- **`isLatest`**: `Boolean` --- **`isPlaceholder`**: `Boolean!` --- **`issueIds`**: `[Int]!` --- **`issues`**: `[Issue]` --- **`itemType`**: `Planitementitytypeenum` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mrpJob`**: `MRPJob` **Arguments:** - `filters`: `MRPJobsInputFilters` --- **`mrpJobId`**: `Int` Declare mrp_job_id column. --- **`name`**: `String!` --- **`parentAllocations`**: `[PlanItemAllocation]` **Arguments:** - `filters`: `PlanItemAllocationsInputFilters` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` Declare part_id column. --- **`partInventories`**: `[PartInventory]` --- **`partInventoryIds`**: `[Int]!` --- **`percentComplete`**: `Int` --- **`planInputIds`**: `[Int]!` --- **`planInputs`**: `PlanInput` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`plans`**: `[Plan]` **Arguments:** - `filters`: `PlansInputFilters` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` Declare procedure_id column. --- **`purchaseOrderLineIds`**: `[Int]!` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` --- **`quantity`**: `Float` --- **`ready`**: `Boolean` --- **`resultEntities`**: `[Entity]` **Arguments:** - `filters`: `EntitysInputFilters` --- **`results`**: `[PlanItemResult]` --- **`runIds`**: `[Int]!` --- **`runs`**: `[Run]` --- **`startTime`**: `DateTime` --- **`status`**: `PlanItemStatus` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` Declare supplier_id column. --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PlanItem($id: ID!) { planItem(id: $id) { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "planItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } } ``` # planItemAllocation Source: https://docs.firstresonance.io/api-reference/queries/planItemAllocation Retrieves an item by its ID. **query** `planItemAllocation(childPlanItemId: ID!, parentPlanItemId: ID!): PlanItemAllocation` ## Arguments **`childPlanItemId`**: `ID!` (required) --- **`parentPlanItemId`**: `ID!` (required) ## Returns `PlanItemAllocation` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`childPlanItem`**: `PlanItem` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`childPlanItemId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`mrpJob`**: `MRPJob` **Arguments:** - `filters`: `MRPJobsInputFilters` --- **`mrpJobId`**: `Int` --- **`parentPlanItem`**: `PlanItem` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`parentPlanItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanItemAllocationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PlanItemAllocation($childPlanItemId: ID!, $parentPlanItemId: ID!) { planItemAllocation(childPlanItemId: $childPlanItemId, parentPlanItemId: $parentPlanItemId) { LastSessionId _created _etag _updated childPlanItem { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } childPlanItemId } } ``` ```json Variables { "childPlanItemId": "id", "parentPlanItemId": "id" } ``` ```json Response { "data": { "planItemAllocation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "childPlanItem": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 }, "childPlanItemId": 1 } } } ``` # planItemAllocations Source: https://docs.firstresonance.io/api-reference/queries/planItemAllocations Retrieves a list of items. **query** `planItemAllocations(after: String, before: String, distinctOn: [PlanItemAllocationSortEnum], filters: PlanItemAllocationsInputFilters, first: Int, last: Int, sort: [PlanItemAllocationSortEnum]): PlanItemAllocationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PlanItemAllocationSortEnum]` --- **`filters`**: `PlanItemAllocationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PlanItemAllocationSortEnum]` ## Returns `PlanItemAllocationsConnection` **`edges`**: `[PlanItemAllocationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PlanItemAllocations { planItemAllocations { edges { cursor node { LastSessionId _created _etag _updated childPlanItem { __typename } childPlanItemId } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "planItemAllocations": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "childPlanItem": { "__typename": "PlanItem" }, "childPlanItemId": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # planItems Source: https://docs.firstresonance.io/api-reference/queries/planItems Retrieves a list of items. **query** `planItems(after: String, before: String, distinctOn: [PlanItemSortEnum], filters: PlanItemsInputFilters, first: Int, last: Int, sort: [PlanItemSortEnum]): PlanItemsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PlanItemSortEnum]` --- **`filters`**: `PlanItemsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PlanItemSortEnum]` ## Returns `PlanItemsConnection` **`edges`**: `[PlanItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PlanItems { planItems { edges { cursor node { LastSessionId _ChildAllocationsCount _CommentsCount _InputsCount _IssuesCount _ParentAllocationsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "planItems": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_ChildAllocationsCount": 1, "_CommentsCount": 1, "_InputsCount": 1, "_IssuesCount": 1, "_ParentAllocationsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # planReservation Source: https://docs.firstresonance.io/api-reference/queries/planReservation Retrieves an item by its ID. **query** `planReservation(id: ID!): PlanReservation` ## Arguments **`id`**: `ID!` (required) ## Returns `PlanReservation` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planId`**: `Int` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanReservationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PlanReservation($id: ID!) { planReservation(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "planReservation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # planReservations Source: https://docs.firstresonance.io/api-reference/queries/planReservations Retrieves a list of items. **query** `planReservations(after: String, before: String, distinctOn: [PlanReservationSortEnum], filters: PlanReservationsInputFilters, first: Int, last: Int, sort: [PlanReservationSortEnum]): PlanReservationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PlanReservationSortEnum]` --- **`filters`**: `PlanReservationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PlanReservationSortEnum]` ## Returns `PlanReservationsConnection` **`edges`**: `[PlanReservationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PlanReservations { planReservations { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "planReservations": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # plans Source: https://docs.firstresonance.io/api-reference/queries/plans Retrieves a list of items. **query** `plans(after: String, before: String, distinctOn: [PlanSortEnum], filters: PlansInputFilters, first: Int, last: Int, sort: [PlanSortEnum]): PlansConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PlanSortEnum]` --- **`filters`**: `PlansInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PlanSortEnum]` ## Returns `PlansConnection` **`edges`**: `[PlansEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Plans { plans { edges { cursor node { Attributes { __typename } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "plans": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PlanAttribute" } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # printers Source: https://docs.firstresonance.io/api-reference/queries/printers Retrieves a list of printers available from PrintNode. **query** `printers: PrintNodePrinterConnection` ## Returns `PrintNodePrinterConnection` **`edges`**: `[PrintNodePrinterEdge]` ## Examples ```graphql Query query Printers { printers { edges { node { description id name state } } } } ``` ```json Response { "data": { "printers": { "edges": [ { "node": { "description": "string", "id": 1, "name": "string", "state": "string" } } ] } } } ``` # prismaticIntegration Source: https://docs.firstresonance.io/api-reference/queries/prismaticIntegration Retrieves information about the Prismatic integration. **query** `prismaticIntegration: PrismaticIntegration` ## Returns `PrismaticIntegration` **`serviceRoutes`**: `PrismaticServiceRoutes!` --- **`token`**: `String` ## Examples ```graphql Query query PrismaticIntegration { prismaticIntegration { serviceRoutes { appUrl } token } } ``` ```json Response { "data": { "prismaticIntegration": { "serviceRoutes": { "appUrl": "string" }, "token": "string" } } } ``` # procedure Source: https://docs.firstresonance.io/api-reference/queries/procedure Retrieves an item by its ID. **query** `procedure(id: ID!): Procedure` ## Arguments **`id`**: `ID!` (required) ## Returns `Procedure` **`Attributes`**: `[ProcedureAttribute]` **Arguments:** - `filters`: `ProcedureAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_FamilyLabelsCount`**: `Int` Optimized count of familyLabels. --- **`_FeedbackCount`**: `Int` Optimized count of feedback. --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_PartProceduresCount`**: `Int` Optimized count of partProcedures. --- **`_PartsCount`**: `Int` Optimized count of parts. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_ProcedureMbomItemsCount`**: `Int` Optimized count of procedureMbomItems. --- **`_ProcedureMbomsCount`**: `Int` Optimized count of procedureMboms. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReviewRequestsCount`**: `Int` Optimized count of reviewRequests. --- **`_ReviewsCount`**: `Int` Optimized count of reviews. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[ProcedureApprovalRequest]` **Arguments:** - `filters`: `ProcedureApprovalRequestsInputFilters` --- **`approvals`**: `[ProcedureApproval]` **Arguments:** - `filters`: `ProcedureApprovalsInputFilters` --- **`attributedParts`**: `[ProcedureAttributedPart]` **Arguments:** - `filters`: `ProcedureAttributedPartsInputFilters` --- **`attributedUsers`**: `[ProcedureAttributedUser]` **Arguments:** - `filters`: `ProcedureAttributedUsersInputFilters` --- **`attributes`**: `[ProcedureAttribute]` --- **`commitMessage`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`exportControlled`**: `Boolean` --- **`family`**: `String` --- **`familyId`**: `Int!` Get column with related family id. This value serves as a "group id" for different versions of the "same" model object. For example, all versions of a standard step will have the same family_id. If a step is not a standard step, this will just equal the value of the step's id. Returns: Column instance --- **`familyLabels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`feedback`**: `[Comment]` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` Define intent option relationship. **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isLatestReleasedVersion`**: `Boolean` --- **`isLatestVersion`**: `Boolean` --- **`isRoleBased`**: `Boolean!` --- **`labels`**: `[String]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` --- **`partProcedures`**: `[PartProcedure]` **Arguments:** - `filters`: `PartProceduresInputFilters` --- **`parts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`procedureMbomItems`**: `[ProcedureMBomItem]` **Arguments:** - `filters`: `ProcedureMBomItemsInputFilters` --- **`procedureMboms`**: `[ProcedureMBom]` **Arguments:** - `filters`: `ProcedureMBomsInputFilters` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`reviewRequests`**: `[ReviewRequest]` **Arguments:** - `filters`: `ReviewRequestsInputFilters` --- **`reviews`**: `[Review]` **Arguments:** - `filters`: `ReviewsInputFilters` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`status`**: `Procedurestatusenum!` --- **`statusTransitionBlockers`**: `[ProcedureStatusTransitionBlocker]` Every gate currently blocking a transition to targetStatus (approvals, MBOM assignment, SPR match, select options, run-usage guards). Empty when the transition is allowed or is a no-op. Read-only — runs the same write-time validators without committing, so clients can preview whether a transition is allowed and why not. Runs several DB queries per procedure; intended for a single procedure preview, not batched across a procedures list. **Arguments:** - `targetStatus`: `Procedurestatusenum!` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureEventFilter` --- **`title`**: `String!` --- **`type`**: `Proceduretypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`version`**: `Int!` ## Examples ```graphql Query query Procedure($id: ID!) { procedure(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "procedure": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } ``` # procedureApproval Source: https://docs.firstresonance.io/api-reference/queries/procedureApproval Retrieves an item by its ID. **query** `procedureApproval(id: ID!): ProcedureApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `ProcedureApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Procedureapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `ProcedureApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int!` --- **`replies`**: `[ProcedureApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ProcedureApproval($id: ID!) { procedureApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "procedureApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # procedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/procedureApprovalRequest Retrieves an item by its ID. **query** `procedureApprovalRequest(id: ID!): ProcedureApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `ProcedureApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Procedureapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int!` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ProcedureApprovalRequest($id: ID!) { procedureApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "procedureApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # procedureApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/procedureApprovalRequests Retrieves a list of items. **query** `procedureApprovalRequests(after: String, before: String, distinctOn: [ProcedureApprovalRequestSortEnum], filters: ProcedureApprovalRequestsInputFilters, first: Int, last: Int, sort: [ProcedureApprovalRequestSortEnum]): ProcedureApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProcedureApprovalRequestSortEnum]` --- **`filters`**: `ProcedureApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProcedureApprovalRequestSortEnum]` ## Returns `ProcedureApprovalRequestsConnection` **`edges`**: `[ProcedureApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ProcedureApprovalRequests { procedureApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedureApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # procedureApprovalRoles Source: https://docs.firstresonance.io/api-reference/queries/procedureApprovalRoles Retrieves a list of items. **query** `procedureApprovalRoles(after: String, before: String, distinctOn: [ProcedureApprovalRoleSortEnum], filters: ProcedureApprovalRolesInputFilters, first: Int, last: Int, sort: [ProcedureApprovalRoleSortEnum]): ProcedureApprovalRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProcedureApprovalRoleSortEnum]` --- **`filters`**: `ProcedureApprovalRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProcedureApprovalRoleSortEnum]` ## Returns `ProcedureApprovalRolesConnection` **`edges`**: `[ProcedureApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ProcedureApprovalRoles { procedureApprovalRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedureApprovalRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # procedureApprovals Source: https://docs.firstresonance.io/api-reference/queries/procedureApprovals Retrieves a list of items. **query** `procedureApprovals(after: String, before: String, distinctOn: [ProcedureApprovalSortEnum], filters: ProcedureApprovalsInputFilters, first: Int, last: Int, sort: [ProcedureApprovalSortEnum]): ProcedureApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProcedureApprovalSortEnum]` --- **`filters`**: `ProcedureApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProcedureApprovalSortEnum]` ## Returns `ProcedureApprovalsConnection` **`edges`**: `[ProcedureApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ProcedureApprovals { procedureApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedureApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # procedureMbomItems Source: https://docs.firstresonance.io/api-reference/queries/procedureMbomItems Retrieves a list of items. **query** `procedureMbomItems(after: String, before: String, distinctOn: [ProcedureMBomItemSortEnum], filters: ProcedureMBomItemsInputFilters, first: Int, last: Int, sort: [ProcedureMBomItemSortEnum]): ProcedureMBomItemsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProcedureMBomItemSortEnum]` --- **`filters`**: `ProcedureMBomItemsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProcedureMBomItemSortEnum]` ## Returns `ProcedureMBomItemsConnection` **`edges`**: `[ProcedureMBomItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ProcedureMbomItems { procedureMbomItems { edges { cursor node { areReferenceDesignatorsFullyAssigned assignedQuantity assignedReferenceDesignatorsCount id isQuantityFullyAssigned mbom { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedureMbomItems": { "edges": [ { "cursor": "string", "node": { "areReferenceDesignatorsFullyAssigned": true, "assignedQuantity": 1.5, "assignedReferenceDesignatorsCount": 1, "id": "string", "isQuantityFullyAssigned": true, "mbom": { "__typename": "MBom" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # procedureMboms Source: https://docs.firstresonance.io/api-reference/queries/procedureMboms Retrieves a list of items. **query** `procedureMboms(after: String, before: String, distinctOn: [ProcedureMBomSortEnum], filters: ProcedureMBomsInputFilters, first: Int, last: Int, sort: [ProcedureMBomSortEnum]): ProcedureMBomsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProcedureMBomSortEnum]` --- **`filters`**: `ProcedureMBomsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProcedureMBomSortEnum]` ## Returns `ProcedureMBomsConnection` **`edges`**: `[ProcedureMBomsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ProcedureMboms { procedureMboms { edges { cursor node { assignedQuantity assignedReferenceDesignatorsCount id mbom { __typename } mbomId percentAssigned } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedureMboms": { "edges": [ { "cursor": "string", "node": { "assignedQuantity": 1.5, "assignedReferenceDesignatorsCount": 1, "id": "string", "mbom": { "__typename": "MBom" }, "mbomId": 1, "percentAssigned": 1.5 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # procedureReferenceDesignators Source: https://docs.firstresonance.io/api-reference/queries/procedureReferenceDesignators Retrieves a list of items. **query** `procedureReferenceDesignators(after: String, before: String, distinctOn: [ProcedureReferenceDesignatorSortEnum], filters: ProcedureReferenceDesignatorsInputFilters, first: Int, last: Int, sort: [ProcedureReferenceDesignatorSortEnum]): ProcedureReferenceDesignatorsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProcedureReferenceDesignatorSortEnum]` --- **`filters`**: `ProcedureReferenceDesignatorsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProcedureReferenceDesignatorSortEnum]` ## Returns `ProcedureReferenceDesignatorsConnection` **`edges`**: `[ProcedureReferenceDesignatorsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ProcedureReferenceDesignators { procedureReferenceDesignators { edges { cursor node { assignedStep { __typename } assignedStepId id mbom { __typename } mbomId procedure { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedureReferenceDesignators": { "edges": [ { "cursor": "string", "node": { "assignedStep": { "__typename": "Step" }, "assignedStepId": 1, "id": "string", "mbom": { "__typename": "MBom" }, "mbomId": 1, "procedure": { "__typename": "Procedure" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # procedures Source: https://docs.firstresonance.io/api-reference/queries/procedures Retrieves a list of items. **query** `procedures(after: String, before: String, createdById: ID, distinctOn: [ProcedureSortEnum], familyId: ID, filters: ProceduresInputFilters, first: Int, isLatestVersion: Boolean, last: Int, sort: [ProcedureSortEnum], status: String, title: String, updatedById: ID): ProceduresConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`createdById`**: `ID` --- **`distinctOn`**: `[ProcedureSortEnum]` --- **`familyId`**: `ID` --- **`filters`**: `ProceduresInputFilters` --- **`first`**: `Int` --- **`isLatestVersion`**: `Boolean` --- **`last`**: `Int` --- **`sort`**: `[ProcedureSortEnum]` --- **`status`**: `String` --- **`title`**: `String` --- **`updatedById`**: `ID` ## Returns `ProceduresConnection` **`edges`**: `[ProceduresEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Procedures { procedures { edges { cursor node { Attributes { __typename } LastSessionId _ApprovalRequestsCount _ApprovalsCount _AttributedPartsCount _AttributedUsersCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "procedures": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "ProcedureAttribute" } ], "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # project Source: https://docs.firstresonance.io/api-reference/queries/project Retrieves an item by its ID. **query** `project(id: ID!): Project` ## Arguments **`id`**: `ID!` (required) ## Returns `Project` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`archived`**: `Boolean!` --- **`code`**: `String!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `ID!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Project($id: ID!) { project(id: $id) { LastSessionId _created _etag _updated archived code } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "project": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } } ``` # projects Source: https://docs.firstresonance.io/api-reference/queries/projects Retrieves a list of items. **query** `projects(after: String, before: String, distinctOn: [ProjectSortEnum], filters: ProjectsInputFilters, first: Int, last: Int, sort: [ProjectSortEnum]): ProjectsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ProjectSortEnum]` --- **`filters`**: `ProjectsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ProjectSortEnum]` ## Returns `ProjectsConnection` **`edges`**: `[ProjectsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Projects { projects { edges { cursor node { LastSessionId _created _etag _updated archived code } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "projects": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "archived": true, "code": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # purchaseOrder Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrder Retrieves an item by its ID. **query** `purchaseOrder(id: ID!): PurchaseOrder` ## Arguments **`id`**: `ID!` (required) ## Returns `PurchaseOrder` **`Attributes`**: `[PurchaseOrderAttribute]` **Arguments:** - `filters`: `PurchaseOrderAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalLevelsCount`**: `Int` Optimized count of approvalLevels. --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_FeesCount`**: `Int` Optimized count of fees. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_RequirementsCount`**: `Int` Optimized count of requirements. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`absoluteFeeCost`**: `Float!` --- **`approvalLevels`**: `[PurchaseOrderApprovalLevel]` **Arguments:** - `filters`: `PurchaseOrderApprovalLevelInputFilters` --- **`approvalRequests`**: `[PurchaseOrderApprovalRequest]` **Arguments:** - `filters`: `PurchaseOrderApprovalRequestsInputFilters` --- **`approvals`**: `[PurchaseOrderApproval]` **Arguments:** - `filters`: `PurchaseOrderApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[PurchaseOrderAttributedPart]` **Arguments:** - `filters`: `PurchaseOrderAttributedPartsInputFilters` --- **`attributedUsers`**: `[PurchaseOrderAttributedUser]` **Arguments:** - `filters`: `PurchaseOrderAttributedUsersInputFilters` --- **`attributes`**: `[PurchaseOrderAttribute]` --- **`billToLocation`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`billToLocationId`**: `Int` --- **`cost`**: `Float` Recommend use of estimatedCost and estimatedTotalCost since they account for all costs on PO lines. > Deprecated: Deprecated in favor of calculated costs. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`currency`**: `Currency` **Arguments:** - `filters`: `CurrenciesInputFilters` --- **`currencyId`**: `Int` --- **`description`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrival`**: `DateTime` Name change to be more consistent with needDate. > Deprecated: Deprecated in favor of estimatedArrivalDate. --- **`estimatedArrivalDate`**: `DateTime` The latest estimated arrival date for a PO line on this PO. --- **`estimatedCost`**: `Float` --- **`estimatedCostNotFeeExempt`**: `Float` --- **`estimatedTotalCost`**: `Float` --- **`externalReference`**: `String` --- **`fees`**: `[PurchaseOrderFee]` **Arguments:** - `filters`: `PurchaseOrderFeesInputFilters` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isOpen`**: `Boolean` --- **`isPartiallyReceived`**: `Boolean` --- **`labels`**: `[Label]` --- **`lastStatusBeforeCancel`**: `Purchaseorderstatusenum` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`needDate`**: `DateTime` The latest need date on the purchase order lines. --- **`orderedAt`**: `DateTime` --- **`paid`**: `Boolean` --- **`percentageFeeCost`**: `Float!` --- **`prettyStr`**: `String` --- **`previousTotalCost`**: `Float` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`requirements`**: `[Requirement]` --- **`shipToLocation`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`shipToLocationId`**: `Int` --- **`status`**: `Purchaseorderstatusenum` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` --- **`supplierInstructions`**: `SlateContent` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`validNextStatuses`**: `[Purchaseorderstatusenum]` ## Examples ```graphql Query query PurchaseOrder($id: ID!) { purchaseOrder(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _ApprovalLevelsCount _ApprovalRequestsCount _ApprovalsCount _AssigneesCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "purchaseOrder": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_ApprovalLevelsCount": 1, "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1 } } } ``` # purchaseOrderApproval Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderApproval Retrieves an item by its ID. **query** `purchaseOrderApproval(id: ID!): PurchaseOrderApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `PurchaseOrderApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `PurchaseOrderApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`replies`**: `[PurchaseOrderApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PurchaseOrderApproval($id: ID!) { purchaseOrderApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "purchaseOrderApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # purchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderApprovalLevel Retrieves an item by its ID. **query** `purchaseOrderApprovalLevel(id: ID!): PurchaseOrderApprovalLevel` ## Arguments **`id`**: `ID!` (required) ## Returns `PurchaseOrderApprovalLevel` **`LastSessionId`**: `String` --- **`_CandidateUsersCount`**: `Int` Optimized count of candidateUsers. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalLevel`**: `ApprovalLevel` **Arguments:** - `filters`: `ApprovalLevelInputFilters` --- **`approvalLevelId`**: `Int!` --- **`approvingUser`**: `User` --- **`approvingUserId`**: `Int` --- **`assignedUser`**: `User` --- **`assignedUserId`**: `Int` --- **`candidateUsers`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` --- **`costThreshold`**: `Int!` Return the minimum purchase order cost that triggers this approval level. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`isTeamSelectedLater`**: `Boolean!` Whether the team should be selected now or when the PO goes into review. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`ordinalPosition`**: `Int!` Return the order of this approval level in the chain. --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`role`**: `Role` --- **`roleId`**: `Int` --- **`status`**: `Approvalstatusenum!` --- **`team`**: `Team` --- **`teamId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderApprovalLevelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PurchaseOrderApprovalLevel($id: ID!) { purchaseOrderApprovalLevel(id: $id) { LastSessionId _CandidateUsersCount _created _etag _updated approvalLevel { LastSessionId _CandidateUsersCount _PurchaseOrderApprovalLevelsCount _created _etag _updated } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "purchaseOrderApprovalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "approvalLevel": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_PurchaseOrderApprovalLevelsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } } ``` # purchaseOrderApprovalLevels Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderApprovalLevels Retrieves a list of items. **query** `purchaseOrderApprovalLevels(after: String, before: String, distinctOn: [PurchaseOrderApprovalLevelSortEnum], filters: PurchaseOrderApprovalLevelInputFilters, first: Int, last: Int, sort: [PurchaseOrderApprovalLevelSortEnum]): PurchaseOrderApprovalLevelsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PurchaseOrderApprovalLevelSortEnum]` --- **`filters`**: `PurchaseOrderApprovalLevelInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PurchaseOrderApprovalLevelSortEnum]` ## Returns `PurchaseOrderApprovalLevelsConnection` **`edges`**: `[PurchaseOrderApprovalLevelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PurchaseOrderApprovalLevels { purchaseOrderApprovalLevels { edges { cursor node { LastSessionId _CandidateUsersCount _created _etag _updated approvalLevel { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "purchaseOrderApprovalLevels": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_CandidateUsersCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "approvalLevel": { "__typename": "ApprovalLevel" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # purchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderApprovalRequest Retrieves an item by its ID. **query** `purchaseOrderApprovalRequest(id: ID!): PurchaseOrderApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `PurchaseOrderApprovalRequest` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PurchaseOrderApprovalRequest($id: ID!) { purchaseOrderApprovalRequest(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "purchaseOrderApprovalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # purchaseOrderApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderApprovalRequests Retrieves a list of items. **query** `purchaseOrderApprovalRequests(after: String, before: String, distinctOn: [PurchaseOrderApprovalRequestSortEnum], filters: PurchaseOrderApprovalRequestsInputFilters, first: Int, last: Int, sort: [PurchaseOrderApprovalRequestSortEnum]): PurchaseOrderApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PurchaseOrderApprovalRequestSortEnum]` --- **`filters`**: `PurchaseOrderApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PurchaseOrderApprovalRequestSortEnum]` ## Returns `PurchaseOrderApprovalRequestsConnection` **`edges`**: `[PurchaseOrderApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PurchaseOrderApprovalRequests { purchaseOrderApprovalRequests { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "purchaseOrderApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # purchaseOrderApprovals Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderApprovals Retrieves a list of items. **query** `purchaseOrderApprovals(after: String, before: String, distinctOn: [PurchaseOrderApprovalSortEnum], filters: PurchaseOrderApprovalsInputFilters, first: Int, last: Int, sort: [PurchaseOrderApprovalSortEnum]): PurchaseOrderApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PurchaseOrderApprovalSortEnum]` --- **`filters`**: `PurchaseOrderApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PurchaseOrderApprovalSortEnum]` ## Returns `PurchaseOrderApprovalsConnection` **`edges`**: `[PurchaseOrderApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PurchaseOrderApprovals { purchaseOrderApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "purchaseOrderApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # purchaseOrderFee Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderFee Retrieves an item by its ID. **query** `purchaseOrderFee(id: ID!): PurchaseOrderFee` ## Arguments **`id`**: `ID!` (required) ## Returns `PurchaseOrderFee` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderFeeEventFilter` --- **`type`**: `Feetypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `Float!` ## Examples ```graphql Query query PurchaseOrderFee($id: ID!) { purchaseOrderFee(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "purchaseOrderFee": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # purchaseOrderFees Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderFees Retrieves a list of items. **query** `purchaseOrderFees(after: String, before: String, distinctOn: [PurchaseOrderFeeSortEnum], filters: PurchaseOrderFeesInputFilters, first: Int, last: Int, sort: [PurchaseOrderFeeSortEnum]): PurchaseOrderFeesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PurchaseOrderFeeSortEnum]` --- **`filters`**: `PurchaseOrderFeesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PurchaseOrderFeeSortEnum]` ## Returns `PurchaseOrderFeesConnection` **`edges`**: `[PurchaseOrderFeesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PurchaseOrderFees { purchaseOrderFees { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "purchaseOrderFees": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # purchaseOrderLine Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderLine Retrieves an item by its ID. **query** `purchaseOrderLine(id: ID!): PurchaseOrderLine` ## Arguments **`id`**: `ID!` (required) ## Returns `PurchaseOrderLine` **`Attributes`**: `[PurchaseOrderLineAttribute]` **Arguments:** - `filters`: `PurchaseOrderLineAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PurchaseOrderLineInventoriesCount`**: `Int` Optimized count of purchaseOrderLineInventories. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_ReceiptsCount`**: `Int` Optimized count of receipts. --- **`_ReceivedPartInventoriesCount`**: `Int` Optimized count of receivedPartInventories. --- **`_RequirementsCount`**: `Int` Optimized count of requirements. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[PurchaseOrderLineAttributedPart]` **Arguments:** - `filters`: `PurchaseOrderLineAttributedPartsInputFilters` --- **`attributedUsers`**: `[PurchaseOrderLineAttributedUser]` **Arguments:** - `filters`: `PurchaseOrderLineAttributedUsersInputFilters` --- **`attributes`**: `[PurchaseOrderLineAttribute]` --- **`chargeAccount`**: `ChargeAccount` **Arguments:** - `filters`: `ChargeAccountsInputFilters` --- **`chargeAccountId`**: `ID` --- **`comments`**: `[Comment]` --- **`cost`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrivalDate`**: `DateTime` --- **`estimatedCost`**: `Float` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`inventoryQuantity`**: `Float` --- **`isOpen`**: `Boolean` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`needDate`**: `DateTime` --- **`originalEstimatedArrivalDate`**: `DateTime` --- **`paid`**: `Boolean!` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`percentageFeeExempt`**: `Boolean!` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`project`**: `Project` **Arguments:** - `filters`: `ProjectsInputFilters` --- **`projectId`**: `ID` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`purchaseOrderLineInventories`**: `[PurchaseOrderLineInventory]` --- **`quantity`**: `Float!` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receipts`**: `[Receipt]` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`receivedPartInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`receivedQuantity`**: `Float` --- **`requirements`**: `[Requirement]` --- **`runStep`**: `RunStep` > Deprecated: Use inventoryRunSteps instead. Returns the run step for a single-serial OSP line only. --- **`runStepId`**: `Int` > Deprecated: Use inventoryRunSteps instead. Returns the run step for a single-serial OSP line only. --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`skipInventoryCreation`**: `Boolean!` --- **`status`**: `Purchaseorderstatusenum!` --- **`supplierPart`**: `SupplierPart` **Arguments:** - `filters`: `SupplierPartsInputFilters` --- **`supplierPartId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderLineEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query PurchaseOrderLine($id: ID!) { purchaseOrderLine(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "purchaseOrderLine": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } ``` # purchaseOrderLines Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrderLines Retrieves a list of items. **query** `purchaseOrderLines(after: String, before: String, distinctOn: [PurchaseOrderLineSortEnum], filters: PurchaseOrderLinesInputFilters, first: Int, last: Int, sort: [PurchaseOrderLineSortEnum]): PurchaseOrderLinesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PurchaseOrderLineSortEnum]` --- **`filters`**: `PurchaseOrderLinesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PurchaseOrderLineSortEnum]` ## Returns `PurchaseOrderLinesConnection` **`edges`**: `[PurchaseOrderLinesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PurchaseOrderLines { purchaseOrderLines { edges { cursor node { Attributes { __typename } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "purchaseOrderLines": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PurchaseOrderLineAttribute" } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # purchaseOrders Source: https://docs.firstresonance.io/api-reference/queries/purchaseOrders Retrieves a list of items. **query** `purchaseOrders(after: String, before: String, distinctOn: [PurchaseOrderSortEnum], filters: PurchaseOrdersInputFilters, first: Int, last: Int, sort: [PurchaseOrderSortEnum]): PurchaseOrdersConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[PurchaseOrderSortEnum]` --- **`filters`**: `PurchaseOrdersInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[PurchaseOrderSortEnum]` ## Returns `PurchaseOrdersConnection` **`edges`**: `[PurchaseOrdersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query PurchaseOrders { purchaseOrders { edges { cursor node { Attributes { __typename } LastSessionId _ApprovalLevelsCount _ApprovalRequestsCount _ApprovalsCount _AssigneesCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "purchaseOrders": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PurchaseOrderAttribute" } ], "LastSessionId": "string", "_ApprovalLevelsCount": 1, "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_AssigneesCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # pylonIntegration Source: https://docs.firstresonance.io/api-reference/queries/pylonIntegration Retrieves information about the Pylon integration. **query** `pylonIntegration: PylonIntegration` ## Returns `PylonIntegration` **`emailHash`**: `String` ## Examples ```graphql Query query PylonIntegration { pylonIntegration { emailHash } } ``` ```json Response { "data": { "pylonIntegration": { "emailHash": "string" } } } ``` # receipt Source: https://docs.firstresonance.io/api-reference/queries/receipt Retrieves an item by its ID. **query** `receipt(id: ID!): Receipt` ## Arguments **`id`**: `ID!` (required) ## Returns `Receipt` **`Attributes`**: `[ReceiptAttribute]` **Arguments:** - `filters`: `ReceiptAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchase order lines. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[ReceiptAttributedPart]` **Arguments:** - `filters`: `ReceiptAttributedPartsInputFilters` --- **`attributedUsers`**: `[ReceiptAttributedUser]` **Arguments:** - `filters`: `ReceiptAttributedUsersInputFilters` --- **`attributes`**: `[ReceiptAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`prettyStr`**: `String` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receivedAt`**: `DateTime!` --- **`receivedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`receivedById`**: `Int!` --- **`receivedParts`**: `[ReceiptItem]` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReceiptEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Receipt($id: ID!) { receipt(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "receipt": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } ``` # receiptItem Source: https://docs.firstresonance.io/api-reference/queries/receiptItem Retrieves an item by its ID. **query** `receiptItem(id: ID!): ReceiptItem` ## Arguments **`id`**: `ID!` (required) ## Returns `ReceiptItem` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`purchaseOrderLine`**: `PurchaseOrderLine` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `Int` --- **`quantity`**: `Float!` --- **`receipt`**: `Receipt` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`receiptId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReceiptItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ReceiptItem($id: ID!) { receiptItem(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "receiptItem": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # receiptItems Source: https://docs.firstresonance.io/api-reference/queries/receiptItems Retrieves a list of items. **query** `receiptItems(after: String, before: String, distinctOn: [ReceiptItemSortEnum], filters: ReceiptItemsInputFilters, first: Int, last: Int, sort: [ReceiptItemSortEnum]): ReceiptItemsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ReceiptItemSortEnum]` --- **`filters`**: `ReceiptItemsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ReceiptItemSortEnum]` ## Returns `ReceiptItemsConnection` **`edges`**: `[ReceiptItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ReceiptItems { receiptItems { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "receiptItems": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # receipts Source: https://docs.firstresonance.io/api-reference/queries/receipts Retrieves a list of items. **query** `receipts(after: String, before: String, distinctOn: [ReceiptSortEnum], filters: ReceiptsInputFilters, first: Int, last: Int, sort: [ReceiptSortEnum]): ReceiptsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ReceiptSortEnum]` --- **`filters`**: `ReceiptsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ReceiptSortEnum]` ## Returns `ReceiptsConnection` **`edges`**: `[ReceiptsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Receipts { receipts { edges { cursor node { Attributes { __typename } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "receipts": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "ReceiptAttribute" } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # recommendation Source: https://docs.firstresonance.io/api-reference/queries/recommendation Provides status for recommendation request. **query** `recommendation(requestId: UUID!): Recommendation` ## Arguments **`requestId`**: `UUID!` (required) A unique identifier for the recommendation request. ## Returns `Recommendation` **`_created`**: `DateTime` --- **`_updated`**: `DateTime` --- **`id`**: `ID!` --- **`objectStoreUri`**: `String` --- **`orgSchema`**: `String!` --- **`requestId`**: `String!` --- **`status`**: `Recommendationstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RecommendationEventFilter` ## Examples ```graphql Query query Recommendation($requestId: UUID!) { recommendation(requestId: $requestId) { _created _updated id objectStoreUri orgSchema requestId } } ``` ```json Variables { "requestId": "value" } ``` ```json Response { "data": { "recommendation": { "_created": "value", "_updated": "value", "id": "id", "objectStoreUri": "string", "orgSchema": "string", "requestId": "string" } } } ``` # redline Source: https://docs.firstresonance.io/api-reference/queries/redline Retrieves an item by its ID. **query** `redline(id: ID!): Redline` ## Arguments **`id`**: `ID!` (required) ## Returns `Redline` **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_RoleBasedApprovalRequestsCount`**: `Int` Optimized count of roleBasedApprovalRequests. --- **`_RoleBasedApprovalsCount`**: `Int` Optimized count of roleBasedApprovals. --- **`_TargetRedlinesCount`**: `Int` Optimized count of targetRedlines. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`active`**: `Boolean` --- **`approvalRequests`**: `[RedlineApprovalRequest]` **Arguments:** - `filters`: `RedlineApprovalRequestsInputFilters` --- **`approvals`**: `[RedlineApproval]` **Arguments:** - `filters`: `RedlineApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`batchSiblings`**: `[Redline]` --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`diff`**: `JSONString` --- **`editable`**: `String` --- **`finalState`**: `JSONString` --- **`id`**: `Int!` --- **`initialState`**: `JSONString` --- **`isRoleBased`**: `Boolean` --- **`issue`**: `Issue` --- **`issueId`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`roleBasedApprovalRequests`**: `[RedlineRoleBasedApprovalRequest]` **Arguments:** - `filters`: `RedlineRoleBasedApprovalRequestsInputFilters` --- **`roleBasedApprovals`**: `[RedlineRoleBasedApproval]` **Arguments:** - `filters`: `RedlineRoleBasedApprovalsInputFilters` --- **`runId`**: `String` --- **`sourceRedline`**: `Redline` --- **`sourceRedlineId`**: `Int` --- **`status`**: `String` --- **`step`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`stepId`**: `Int!` --- **`targetRedlines`**: `[Redline]` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Redline($id: ID!) { redline(id: $id) { LastSessionId _ApprovalRequestsCount _ApprovalsCount _RoleBasedApprovalRequestsCount _RoleBasedApprovalsCount _TargetRedlinesCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "redline": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_RoleBasedApprovalRequestsCount": 1, "_RoleBasedApprovalsCount": 1, "_TargetRedlinesCount": 1 } } } ``` # redlineApproval Source: https://docs.firstresonance.io/api-reference/queries/redlineApproval Retrieves an item by its ID. **query** `redlineApproval(id: ID!): RedlineApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `RedlineApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batchSiblings`**: `[RedlineApproval]` --- **`batched`**: `Boolean` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `RedlineApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`replies`**: `[RedlineApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query RedlineApproval($id: ID!) { redlineApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated batchSiblings { __typename } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "redlineApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApproval" } ] } } } ``` # redlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/redlineApprovalRequest Retrieves an item by its ID. **query** `redlineApprovalRequest(id: ID!): RedlineApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `RedlineApprovalRequest` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batchSiblings`**: `[RedlineApprovalRequest]` --- **`batched`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query RedlineApprovalRequest($id: ID!) { redlineApprovalRequest(id: $id) { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "redlineApprovalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApprovalRequest" } ], "batched": "string" } } } ``` # redlineApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/redlineApprovalRequests Retrieves a list of items. **query** `redlineApprovalRequests(after: String, before: String, distinctOn: [RedlineApprovalRequestSortEnum], filters: RedlineApprovalRequestsInputFilters, first: Int, last: Int, sort: [RedlineApprovalRequestSortEnum]): RedlineApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RedlineApprovalRequestSortEnum]` --- **`filters`**: `RedlineApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RedlineApprovalRequestSortEnum]` ## Returns `RedlineApprovalRequestsConnection` **`edges`**: `[RedlineApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RedlineApprovalRequests { redlineApprovalRequests { edges { cursor node { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "redlineApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApprovalRequest" } ], "batched": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # redlineApprovalRoles Source: https://docs.firstresonance.io/api-reference/queries/redlineApprovalRoles Retrieves a list of items. **query** `redlineApprovalRoles(after: String, before: String, distinctOn: [RedlineApprovalRoleSortEnum], filters: RedlineApprovalRolesInputFilters, first: Int, last: Int, sort: [RedlineApprovalRoleSortEnum]): RedlineApprovalRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RedlineApprovalRoleSortEnum]` --- **`filters`**: `RedlineApprovalRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RedlineApprovalRoleSortEnum]` ## Returns `RedlineApprovalRolesConnection` **`edges`**: `[RedlineApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RedlineApprovalRoles { redlineApprovalRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "redlineApprovalRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # redlineApprovals Source: https://docs.firstresonance.io/api-reference/queries/redlineApprovals Retrieves a list of items. **query** `redlineApprovals(after: String, before: String, distinctOn: [RedlineApprovalSortEnum], filters: RedlineApprovalsInputFilters, first: Int, last: Int, sort: [RedlineApprovalSortEnum]): RedlineApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RedlineApprovalSortEnum]` --- **`filters`**: `RedlineApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RedlineApprovalSortEnum]` ## Returns `RedlineApprovalsConnection` **`edges`**: `[RedlineApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RedlineApprovals { redlineApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated batchSiblings { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "redlineApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RedlineApproval" } ] } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # redlineRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/queries/redlineRoleBasedApproval Retrieves an item by its ID. **query** `redlineRoleBasedApproval(id: ID!): RedlineRoleBasedApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `RedlineRoleBasedApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batched`**: `String` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Redlineapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `RedlineRoleBasedApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`replies`**: `[RedlineRoleBasedApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineRoleBasedApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query RedlineRoleBasedApproval($id: ID!) { redlineRoleBasedApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated batched } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "redlineRoleBasedApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batched": "string" } } } ``` # redlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/redlineRoleBasedApprovalRequest Retrieves an item by its ID. **query** `redlineRoleBasedApprovalRequest(id: ID!): RedlineRoleBasedApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `RedlineRoleBasedApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`batched`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Redlineapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineRoleBasedApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query RedlineRoleBasedApprovalRequest($id: ID!) { redlineRoleBasedApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "redlineRoleBasedApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # redlineRoleBasedApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/redlineRoleBasedApprovalRequests Retrieves a list of items. **query** `redlineRoleBasedApprovalRequests(after: String, before: String, distinctOn: [RedlineRoleBasedApprovalRequestSortEnum], filters: RedlineRoleBasedApprovalRequestsInputFilters, first: Int, last: Int, sort: [RedlineRoleBasedApprovalRequestSortEnum]): RedlineRoleBasedApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RedlineRoleBasedApprovalRequestSortEnum]` --- **`filters`**: `RedlineRoleBasedApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RedlineRoleBasedApprovalRequestSortEnum]` ## Returns `RedlineRoleBasedApprovalRequestsConnection` **`edges`**: `[RedlineRoleBasedApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RedlineRoleBasedApprovalRequests { redlineRoleBasedApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "redlineRoleBasedApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # redlineRoleBasedApprovals Source: https://docs.firstresonance.io/api-reference/queries/redlineRoleBasedApprovals Retrieves a list of items. **query** `redlineRoleBasedApprovals(after: String, before: String, distinctOn: [RedlineRoleBasedApprovalSortEnum], filters: RedlineRoleBasedApprovalsInputFilters, first: Int, last: Int, sort: [RedlineRoleBasedApprovalSortEnum]): RedlineRoleBasedApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RedlineRoleBasedApprovalSortEnum]` --- **`filters`**: `RedlineRoleBasedApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RedlineRoleBasedApprovalSortEnum]` ## Returns `RedlineRoleBasedApprovalsConnection` **`edges`**: `[RedlineRoleBasedApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RedlineRoleBasedApprovals { redlineRoleBasedApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated batched } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "redlineRoleBasedApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "batched": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # redlines Source: https://docs.firstresonance.io/api-reference/queries/redlines Retrieves a list of items. **query** `redlines(after: String, before: String, distinctOn: [RedlineSortEnum], filters: RedlinesInputFilters, first: Int, last: Int, sort: [RedlineSortEnum]): RedlinesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RedlineSortEnum]` --- **`filters`**: `RedlinesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RedlineSortEnum]` ## Returns `RedlinesConnection` **`edges`**: `[RedlinesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Redlines { redlines { edges { cursor node { LastSessionId _ApprovalRequestsCount _ApprovalsCount _RoleBasedApprovalRequestsCount _RoleBasedApprovalsCount _TargetRedlinesCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "redlines": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_ApprovalRequestsCount": 1, "_ApprovalsCount": 1, "_RoleBasedApprovalRequestsCount": 1, "_RoleBasedApprovalsCount": 1, "_TargetRedlinesCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # requestFileUploadUrl Source: https://docs.firstresonance.io/api-reference/queries/requestFileUploadUrl Generates a presigned URL for uploading a file. **query** `requestFileUploadUrl(filename: String!): RequestFileUploadUrl` ## Arguments **`filename`**: `String!` (required) ## Returns `RequestFileUploadUrl` **`contentType`**: `String!` --- **`s3Key`**: `String!` --- **`uploadUrl`**: `String!` ## Examples ```graphql Query query RequestFileUploadUrl($filename: String!) { requestFileUploadUrl(filename: $filename) { contentType s3Key uploadUrl } } ``` ```json Variables { "filename": "string" } ``` ```json Response { "data": { "requestFileUploadUrl": { "contentType": "string", "s3Key": "string", "uploadUrl": "string" } } } ``` # requestImportJobUploadUrl Source: https://docs.firstresonance.io/api-reference/queries/requestImportJobUploadUrl Generates a presigned URL for uploading a file for an import job. **query** `requestImportJobUploadUrl(bucketType: String, filename: String!): RequestImportJobUploadUrl` ## Arguments **`bucketType`**: `String` --- **`filename`**: `String!` (required) ## Returns `RequestImportJobUploadUrl` **`contentType`**: `String!` --- **`s3Key`**: `String!` --- **`uploadUrl`**: `String!` ## Examples ```graphql Query query RequestImportJobUploadUrl($filename: String!) { requestImportJobUploadUrl(filename: $filename) { contentType s3Key uploadUrl } } ``` ```json Variables { "filename": "string" } ``` ```json Response { "data": { "requestImportJobUploadUrl": { "contentType": "string", "s3Key": "string", "uploadUrl": "string" } } } ``` # requirement Source: https://docs.firstresonance.io/api-reference/queries/requirement Retrieves an item by its ID. **query** `requirement(id: ID!): Requirement` ## Arguments **`id`**: `ID!` (required) ## Returns `Requirement` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`referenceName`**: `String` --- **`requirementType`**: `Requirementtypeenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RequirementEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Requirement($id: ID!) { requirement(id: $id) { LastSessionId _created _etag _updated content createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "requirement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "content": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # requirements Source: https://docs.firstresonance.io/api-reference/queries/requirements Retrieves a list of items. **query** `requirements(after: String, before: String, distinctOn: [RequirementSortEnum], filters: RequirementsInputFilters, first: Int, last: Int, sort: [RequirementSortEnum]): RequirementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RequirementSortEnum]` --- **`filters`**: `RequirementsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RequirementSortEnum]` ## Returns `RequirementsConnection` **`edges`**: `[RequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Requirements { requirements { edges { cursor node { LastSessionId _created _etag _updated content createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "requirements": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "content": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # review Source: https://docs.firstresonance.io/api-reference/queries/review Retrieves an item by its ID. **query** `review(id: ID!): Review` ## Arguments **`id`**: `ID!` (required) ## Returns `Review` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` > Deprecated: "comment" is being deprecated in favor of "content" in order to include rich text content. --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `Review` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`replies`**: `[Review]` --- **`resolved`**: `Boolean` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReviewEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Review($id: ID!) { review(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "review": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # reviewRequest Source: https://docs.firstresonance.io/api-reference/queries/reviewRequest Retrieves an item by its ID. **query** `reviewRequest(id: ID!): ReviewRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `ReviewRequest` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `Reviewstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReviewRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query ReviewRequest($id: ID!) { reviewRequest(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "reviewRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # reviewRequests Source: https://docs.firstresonance.io/api-reference/queries/reviewRequests Retrieves a list of items. **query** `reviewRequests(after: String, before: String, distinctOn: [ReviewRequestSortEnum], filters: ReviewsInputFilters, first: Int, last: Int, sort: [ReviewRequestSortEnum]): ReviewRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ReviewRequestSortEnum]` --- **`filters`**: `ReviewsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ReviewRequestSortEnum]` ## Returns `ReviewRequestsConnection` **`edges`**: `[ReviewRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ReviewRequests { reviewRequests { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "reviewRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # reviews Source: https://docs.firstresonance.io/api-reference/queries/reviews Retrieves a list of items. **query** `reviews(after: String, before: String, distinctOn: [ReviewSortEnum], filters: ReviewsInputFilters, first: Int, last: Int, sort: [ReviewSortEnum]): ReviewsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ReviewSortEnum]` --- **`filters`**: `ReviewsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ReviewSortEnum]` ## Returns `ReviewsConnection` **`edges`**: `[ReviewsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Reviews { reviews { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "reviews": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # role Source: https://docs.firstresonance.io/api-reference/queries/role Retrieves an item by its ID. **query** `role(id: ID!): Role` ## Arguments **`id`**: `ID!` (required) ## Returns `Role` **`LastSessionId`**: `String` --- **`_IssueApprovalRequestsCount`**: `Int` Optimized count of issueApprovalRequests. --- **`_IssueApprovalsCount`**: `Int` Optimized count of issueApprovals. --- **`_IssueDispositionTypeRolesCount`**: `Int` Optimized count of issueDispositionTypeRoles. --- **`_PermissionGroupRolesCount`**: `Int` Optimized count of permissionGroupRoles. --- **`_PermissionGroupsCount`**: `Int` Optimized count of permissionGroups. --- **`_TeamRolesCount`**: `Int` Optimized count of teamRoles. --- **`_TeamsCount`**: `Int` Optimized count of teams. --- **`_UserRolesCount`**: `Int` Optimized count of userRoles. --- **`_UsersCount`**: `Int` Optimized count of users. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`archived`**: `Boolean!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`issueApprovalRequests`**: `[IssueApprovalRequest]` **Arguments:** - `filters`: `IssueApprovalRequestsInputFilters` --- **`issueApprovals`**: `[IssueApproval]` **Arguments:** - `filters`: `IssueApprovalsInputFilters` --- **`issueDispositionTypeRoles`**: `[IssueDispositionTypeRole]` **Arguments:** - `filters`: `IssueDispositionTypeRolesInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`permissionGroups`**: `[PermissionGroup]` **Arguments:** - `filters`: `PermissionGroupsInputFilters` --- **`prettyStr`**: `String` --- **`teamRoles`**: `[TeamRole]` **Arguments:** - `filters`: `TeamRolesInputFilters` --- **`teams`**: `[Team]` **Arguments:** - `filters`: `TeamsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id --- **`userRoles`**: `[UserRole]` **Arguments:** - `filters`: `UserRolesInputFilters` --- **`users`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` ## Examples ```graphql Query query Role($id: ID!) { role(id: $id) { LastSessionId _IssueApprovalRequestsCount _IssueApprovalsCount _IssueDispositionTypeRolesCount _PermissionGroupRolesCount _PermissionGroupsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "role": { "LastSessionId": "string", "_IssueApprovalRequestsCount": 1, "_IssueApprovalsCount": 1, "_IssueDispositionTypeRolesCount": 1, "_PermissionGroupRolesCount": 1, "_PermissionGroupsCount": 1 } } } ``` # roles Source: https://docs.firstresonance.io/api-reference/queries/roles Retrieves a list of items. **query** `roles(after: String, before: String, distinctOn: [RoleSortEnum], filters: RolesInputFilters, first: Int, last: Int, sort: [RoleSortEnum]): RolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RoleSortEnum]` --- **`filters`**: `RolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RoleSortEnum]` ## Returns `RolesConnection` **`edges`**: `[RolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Roles { roles { edges { cursor node { LastSessionId _IssueApprovalRequestsCount _IssueApprovalsCount _IssueDispositionTypeRolesCount _PermissionGroupRolesCount _PermissionGroupsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "roles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_IssueApprovalRequestsCount": 1, "_IssueApprovalsCount": 1, "_IssueDispositionTypeRolesCount": 1, "_PermissionGroupRolesCount": 1, "_PermissionGroupsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # rule Source: https://docs.firstresonance.io/api-reference/queries/rule Retrieves an item by its ID. **query** `rule(id: ID!): Rule` ## Arguments **`id`**: `ID!` (required) ## Returns `Rule` **`LastSessionId`**: `String` --- **`_ExecutionLogsCount`**: `Int` Optimized count of executionLogs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`aiDescription`**: `String` --- **`code`**: `String` --- **`codeHash`**: `String!` --- **`context`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`enabled`**: `Boolean` --- **`errorState`**: `RuleErrorState` --- **`eventType`**: `RuleEventType` --- **`executionLogs`**: `[RuleExecutionLog]` **Arguments:** - `filters`: `RuleExecutionLogsInputFilters` --- **`id`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`ruleType`**: `RuleType` --- **`status`**: `RuleStatus` --- **`target`**: `RuleTargetEnum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RuleEventFilter` --- **`title`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`version`**: `Int` ## Examples ```graphql Query query Rule($id: ID!) { rule(id: $id) { LastSessionId _ExecutionLogsCount _created _etag _updated aiDescription } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "rule": { "LastSessionId": "string", "_ExecutionLogsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "aiDescription": "string" } } } ``` # ruleDryRun Source: https://docs.firstresonance.io/api-reference/queries/ruleDryRun Runs an unsaved Action through the real rules engine against real records and reports what happened. Commits nothing and writes no execution log. **query** `ruleDryRun(changes: JSONString, draft: RuleDryRunInput!, entityIds: [Int]!): RuleDryRun` ## Arguments **`changes`**: `JSONString` --- **`draft`**: `RuleDryRunInput!` (required) --- **`entityIds`**: `[Int]!` (required) ## Returns `RuleDryRun` **`contextQuery`**: `String` The rebuilt query that ran, which is not the draft's own string. --- **`errorState`**: `String` block | warn, from the raised exception. --- **`evaluatedIds`**: `[Int]` --- **`message`**: `String` --- **`messageDropped`**: `Boolean` The Action supplies a message the engine discards, so whoever trips this Action sees only its title and not the reason. Static: it covers branches this run did not take. --- **`messageDroppedReason`**: `String` Why the message was discarded, or null when none was. --- **`observedContext`**: `JSONString` The context the Action's code actually received. Empty means the record was filtered out of the Action's own context query, so the Action is inert. --- **`outcome`**: `String` passed | blocked | warned | errored. 'errored' means the Action could not be run — it is not a violation. --- **`raised`**: `Boolean` Did the Action's code raise? --- **`saveError`**: `String` --- **`saveValid`**: `Boolean` Would this draft survive CreateRule? ## Examples ```graphql Query query RuleDryRun($draft: RuleDryRunInput!, $entityIds: [Int]!) { ruleDryRun(draft: $draft, entityIds: $entityIds) { contextQuery errorState evaluatedIds message messageDropped messageDroppedReason } } ``` ```json Variables { "draft": { "code": "string", "context": "string", "eventType": "CREATE", "target": "ABOMINSTALLATION" }, "entityIds": [ 1 ] } ``` ```json Response { "data": { "ruleDryRun": { "contextQuery": "string", "errorState": "string", "evaluatedIds": [ 1 ], "message": "string", "messageDropped": true, "messageDroppedReason": "string" } } } ``` # ruleExecutionLog Source: https://docs.firstresonance.io/api-reference/queries/ruleExecutionLog Retrieves a rule execution log by UUID. **query** `ruleExecutionLog(uuid: UUID!): RuleExecutionLog` ## Arguments **`uuid`**: `UUID!` (required) ## Returns `RuleExecutionLog` **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allRuleIds`**: `[Int]` --- **`context`**: `JSONString` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`errorMessage`**: `String` --- **`executableCode`**: `String!` --- **`executionTimeMs`**: `Int` --- **`frontendRequestId`**: `String` --- **`prettyStr`**: `String` --- **`raisedRule`**: `Rule` **Arguments:** - `filters`: `RulesInputFilters` --- **`raisedRuleId`**: `Int` --- **`ruleEvent`**: `RuleEventType` --- **`ruleTarget`**: `RuleTargetEnum` --- **`rules`**: `[Rule]` **Arguments:** - `filters`: `RulesInputFilters` --- **`targetRecordIds`**: `[String]` --- **`targetRecords`**: `[RuleExecutionLogTargetRecord]` **Arguments:** - `filters`: `RuleExecutionLogTargetRecordsInputFilters` --- **`uuid`**: `UUID` ## Examples ```graphql Query query RuleExecutionLog($uuid: UUID!) { ruleExecutionLog(uuid: $uuid) { _created _etag _updated allRuleIds context createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "uuid": "value" } ``` ```json Response { "data": { "ruleExecutionLog": { "_created": "value", "_etag": "string", "_updated": "value", "allRuleIds": [ 1 ], "context": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # ruleExecutionLogs Source: https://docs.firstresonance.io/api-reference/queries/ruleExecutionLogs Retrieves a list of items. **query** `ruleExecutionLogs(after: String, before: String, distinctOn: [RuleExecutionLogSortEnum], filters: RuleExecutionLogsInputFilters, first: Int, last: Int, sort: [RuleExecutionLogSortEnum]): RuleExecutionLogsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RuleExecutionLogSortEnum]` --- **`filters`**: `RuleExecutionLogsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RuleExecutionLogSortEnum]` ## Returns `RuleExecutionLogsConnection` **`edges`**: `[RuleExecutionLogsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RuleExecutionLogs { ruleExecutionLogs { edges { cursor node { _created _etag _updated allRuleIds context createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "ruleExecutionLogs": { "edges": [ { "cursor": "string", "node": { "_created": "value", "_etag": "string", "_updated": "value", "allRuleIds": [ 1 ], "context": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # ruleExecutionLogsMetrics Source: https://docs.firstresonance.io/api-reference/queries/ruleExecutionLogsMetrics Retrieves the number of rule execution logs and errors. **query** `ruleExecutionLogsMetrics(filters: RuleExecutionLogsInputFilters): RuleExecutionLogsMetrics` ## Arguments **`filters`**: `RuleExecutionLogsInputFilters` ## Returns `RuleExecutionLogsMetrics` **`errorCount`**: `Int` Number of rule execution logs with errors. --- **`totalCount`**: `Int` Total number of rule execution logs. ## Examples ```graphql Query query RuleExecutionLogsMetrics { ruleExecutionLogsMetrics { errorCount totalCount } } ``` ```json Response { "data": { "ruleExecutionLogsMetrics": { "errorCount": 1, "totalCount": 1 } } } ``` # rules Source: https://docs.firstresonance.io/api-reference/queries/rules Retrieves a list of items. **query** `rules(after: String, before: String, distinctOn: [RuleSortEnum], filters: RulesInputFilters, first: Int, last: Int, sort: [RuleSortEnum]): RulesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RuleSortEnum]` --- **`filters`**: `RulesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RuleSortEnum]` ## Returns `RulesConnection` **`edges`**: `[RulesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Rules { rules { edges { cursor node { LastSessionId _ExecutionLogsCount _created _etag _updated aiDescription } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "rules": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_ExecutionLogsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "aiDescription": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # run Source: https://docs.firstresonance.io/api-reference/queries/run Retrieves an item by its ID. **query** `run(id: ID!): Run` ## Arguments **`id`**: `ID!` (required) ## Returns `Run` **`Attributes`**: `[RunAttribute]` **Arguments:** - `filters`: `RunAttributesInputFilters` --- **`ExportControlled`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FurtherActionsCount`**: `Int` Optimized count of furtherActions. --- **`_IssuesCount`**: `Int` --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_LocationsCount`**: `Int` --- **`_OriginPartInventoriesCount`**: `Int` Optimized count of originPartInventories. --- **`_PartKitsCount`**: `Int` Optimized count of partKits. --- **`_RedlinesCount`**: `Int` --- **`_SessionsCount`**: `Int` --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomCompletionJustification`**: `String` --- **`abomCompletionJustificationAt`**: `DateTime` --- **`abomCompletionJustificationBy`**: `Int` --- **`abomCompletionJustificationUser`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`abomJustificationSubmitted`**: `Boolean!` --- **`allBatchedSiblings`**: `[Run]` --- **`archived`**: `Boolean!` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[RunAttributedPart]` **Arguments:** - `filters`: `RunAttributedPartsInputFilters` --- **`attributedUsers`**: `[RunAttributedUser]` **Arguments:** - `filters`: `RunAttributedUsersInputFilters` --- **`attributes`**: `[RunAttribute]` --- **`batchAdoptedSiblings`**: `[Run]` --- **`batchSiblings`**: `[Run]` --- **`batched`**: `Boolean` --- **`calculatedLeadTime`**: `Int` --- **`comments`**: `[Comment]` --- **`completedBy`**: `User` --- **`completedQuantity`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`dueDate`**: `DateTime` --- **`endTime`**: `DateTime` End time is calculated from the latest run step end time. --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`exportControlled`**: `Boolean` --- **`fileAttachments`**: `[FileAttachment]` --- **`furtherActions`**: `[FurtherAction]` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isComplexAssembly`**: `Boolean` --- **`isOpen`**: `Boolean` --- **`issues`**: `[Issue]` --- **`jiraIssueKey`**: `String` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` --- **`originPartInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`partKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`percentComplete`**: `Int` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`quantity`**: `Int` --- **`redlines`**: `[Redline]` --- **`resultsLink`**: `String` --- **`runBatch`**: `RunBatch` **Arguments:** - `filters`: `RunBatchesInputFilters` --- **`runBatchId`**: `Int` --- **`scheduledEnd`**: `DateTime` Scheduled end is calculated from the latest scheduled run step. --- **`scheduledStart`**: `DateTime` --- **`sessions`**: `[Session]` --- **`startTime`**: `DateTime` Start time is calculated from the earliest run step start time. --- **`startedBy`**: `User` --- **`status`**: `RunStatus` --- **`steps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Run($id: ID!) { run(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "run": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } } ``` # runBatch Source: https://docs.firstresonance.io/api-reference/queries/runBatch Retrieves an item by its ID. **query** `runBatch(id: ID!): RunBatch` ## Arguments **`id`**: `ID!` (required) ## Returns `RunBatch` **`LastSessionId`**: `String` --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`runs`**: `[Run]` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunBatchEventFilter` --- **`title`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query RunBatch($id: ID!) { runBatch(id: $id) { LastSessionId _RunsCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "runBatch": { "LastSessionId": "string", "_RunsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # runBatchs Source: https://docs.firstresonance.io/api-reference/queries/runBatchs Retrieves a list of items. **query** `runBatchs(after: String, before: String, distinctOn: [RunBatchSortEnum], filters: RunBatchesInputFilters, first: Int, last: Int, sort: [RunBatchSortEnum]): RunBatchsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RunBatchSortEnum]` --- **`filters`**: `RunBatchesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RunBatchSortEnum]` ## Returns `RunBatchsConnection` **`edges`**: `[RunBatchsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RunBatchs { runBatchs { edges { cursor node { LastSessionId _RunsCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "runBatchs": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RunsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # runStep Source: https://docs.firstresonance.io/api-reference/queries/runStep Retrieves an item by its ID. **query** `runStep(id: ID!): RunStep` ## Arguments **`id`**: `ID!` (required) ## Returns `RunStep` **`Attributes`**: `[RunStepAttribute]` **Arguments:** - `filters`: `RunStepAttributesInputFilters` --- **`Parent`**: `String` --- **`Sessions`**: `[SessionEvent]` > Deprecated: The Sessions field is being deprecated in favor of the sessions field. --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AllChildrenCount`**: `Int` --- **`_AllParentsCount`**: `Int` --- **`_AncestorRunStepsCount`**: `Int` Optimized count of ancestorRunSteps. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BlockingIssuesCount`**: `Int` Optimized count of blockingIssues. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_DatagridColumnsCount`**: `Int` Optimized count of datagridColumns. --- **`_DatagridRowsCount`**: `Int` Optimized count of datagridRows. --- **`_DescendantRunStepsCount`**: `Int` Optimized count of descendantRunSteps. --- **`_DownstreamCount`**: `Int` Optimized count of downstream. --- **`_FieldsCount`**: `Int` Optimized count of fields. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_MustCloseByLinkedIssuesCount`**: `Int` Optimized count of mustCloseByLinkedIssues. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_RedlinesCount`**: `Int` Optimized count of redlines. --- **`_RunStepBuildRequirementsCount`**: `Int` Optimized count of runStepBuildRequirements. --- **`_SessionsCount`**: `Int` Optimized count of sessions. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_UpstreamCount`**: `Int` Optimized count of upstream. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`activeRedline`**: `Redline` --- **`activeRedlineId`**: `Int` --- **`allBatchedSiblings`**: `[RunStep]` --- **`allChildren`**: `[RunStep]` --- **`allParents`**: `[RunStep]` --- **`ancestorRunSteps`**: `[RunStep]` --- **`assets`**: `[FileAttachment]` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[RunStepAttributedPart]` **Arguments:** - `filters`: `RunStepAttributedPartsInputFilters` --- **`attributedUsers`**: `[RunStepAttributedUser]` **Arguments:** - `filters`: `RunStepAttributedUsersInputFilters` --- **`attributes`**: `[RunStepAttribute]` --- **`availableToWork`**: `Boolean` --- **`batchAdoptedSiblings`**: `[RunStep]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[RunStep]` --- **`batched`**: `Boolean` --- **`blockingIssues`**: `[Issue]` --- **`calculatedLeadTime`**: `Int` --- **`canComplete`**: `Boolean!` True when this step can transition to COMPLETE — every step-level completion validator passes (required installs incl. batch siblings, required fields, child steps complete/canceled, required datagrid rows, field validations). False for statuses that cannot transition to COMPLETE. Run-completion gates are not evaluated: completing the run's last step can still be rejected by run-level ABOM part checks or user-defined rules (write/commit-time only). --- **`comments`**: `[Comment]` --- **`completedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`completedById`**: `Int` --- **`content`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`datagrid`**: `DataGrid` > Deprecated: Deprecated --- **`datagridColumns`**: `DatagridColumnsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridColumnsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridColumnSortEnum]` --- **`datagridRows`**: `DatagridRowsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridRowsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridRowSortEnum]` --- **`descendantRunSteps`**: `[RunStep]` --- **`displayPdf`**: `Boolean!` --- **`downstream`**: `[RunStepsEdge]` **Arguments:** - `filters`: `RunStepsEdgesInputFilters` --- **`downstreamStepIds`**: `[Int]` --- **`editable`**: `String` --- **`endTime`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fields`**: `[RunStepField]` **Arguments:** - `filters`: `RunStepFieldInputFilters` --- **`fileAttachments`**: `[FileAttachment]` --- **`fullPosition`**: `String` --- **`hashCode`**: `String` --- **`id`**: `Int!` --- **`isChildStandardStep`**: `Boolean` --- **`isLatched`**: `Boolean` True if the run step has been latched to a specific standard step version. A latched step has been separated from its standard step dependency and locked to a specific version. --- **`isOutsideProcess`**: `Boolean!` --- **`isStandardStep`**: `Boolean!` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`leadTime`**: `Int` --- **`location`**: `Location` Return location relationship. **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` Return location foreign key. --- **`mustCloseByLinkedIssues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`originStep`**: `Step` Return step which self was generated from. **Arguments:** - `filters`: `StepsFilters` --- **`originStepId`**: `Int` Return step id from which a copied step originated. --- **`pages`**: `[Int]` --- **`parent`**: `RunStep` --- **`parentId`**: `Int` Return self referential parent foreign key. --- **`parentIds`**: `[Int]` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`pdf`**: `FileAttachment` Return pdf relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`pdfAssetId`**: `Int` Return pdf foreign key. --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`redlines`**: `[Redline]` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`resultsHtmlLink`**: `String` --- **`resultsLink`**: `String` --- **`resultsS3Bucket`**: `String` --- **`resultsS3Key`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int!` --- **`runStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`scheduledEnd`**: `DateTime` --- **`scheduledStart`**: `DateTime` --- **`sessions`**: `[Session]` --- **`settable`**: `String` --- **`slateContent`**: `SlateContent` --- **`sourceStep`**: `Step` --- **`standardStep`**: `Step` --- **`standardStepId`**: `Int` --- **`standardStepVersion`**: `Int` --- **`startTime`**: `DateTime` --- **`startedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`startedById`**: `Int` --- **`status`**: `Statusenum!` --- **`steps`**: `[RunStep]` --- **`stepsCount`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepEventFilter` --- **`title`**: `String!` --- **`type`**: `runstepsteptypes` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstream`**: `[RunStepsEdge]` **Arguments:** - `filters`: `RunStepsEdgesInputFilters` --- **`upstreamStepIds`**: `[Int]` --- **`validNextStatuses`**: `[Statusenum]` ## Examples ```graphql Query query RunStep($id: ID!) { runStep(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent Sessions { Created LastSessionId Updated checkIn checkOut createdBy { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "runStep": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "Sessions": [ { "Created": "value", "LastSessionId": "string", "Updated": "value", "checkIn": "value", "checkOut": "value", "createdBy": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } } ``` # runStepBuildRequirements Source: https://docs.firstresonance.io/api-reference/queries/runStepBuildRequirements Retrieves a list of items. **query** `runStepBuildRequirements(after: String, before: String, distinctOn: [RunStepBuildRequirementSortEnum], filters: RunStepBuildRequirementsInputFilters, first: Int, last: Int, sort: [RunStepBuildRequirementSortEnum]): RunStepBuildRequirementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RunStepBuildRequirementSortEnum]` --- **`filters`**: `RunStepBuildRequirementsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RunStepBuildRequirementSortEnum]` ## Returns `RunStepBuildRequirementsConnection` **`edges`**: `[RunStepBuildRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RunStepBuildRequirements { runStepBuildRequirements { edges { cursor node { Deleted LastSessionId _AbomInstallationsCount _AssignedAndInstalledReferenceDesignatorsCount _AssignedReferenceDesignatorsCount _InstalledReferenceDesignatorsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "runStepBuildRequirements": { "edges": [ { "cursor": "string", "node": { "Deleted": true, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AssignedAndInstalledReferenceDesignatorsCount": 1.5, "_AssignedReferenceDesignatorsCount": 1, "_InstalledReferenceDesignatorsCount": 1.5 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # runStepEdge Source: https://docs.firstresonance.io/api-reference/queries/runStepEdge Retrieves an item by its ID. **query** `runStepEdge(id: ID!): RunStepsEdge` ## Arguments **`id`**: `ID!` (required) ## Returns `RunStepsEdge` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batchSiblings`**: `[RunStepsEdge]` --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`step`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepsEdgeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstreamStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`upstreamStepId`**: `Int!` ## Examples ```graphql Query query RunStepEdge($id: ID!) { runStepEdge(id: $id) { LastSessionId _created _etag _updated batchSiblings { __typename } batched } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "runStepEdge": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "batchSiblings": [ { "__typename": "RunStepsEdge" } ], "batched": true } } } ``` # runStepField Source: https://docs.firstresonance.io/api-reference/queries/runStepField Retrieves an item by its ID. **query** `runStepField(id: ID!): RunStepField` ## Arguments **`id`**: `ID!` (required) ## Returns `RunStepField` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_IonValueCount`**: `Int` --- **`_ValidationsCount`**: `Int` Optimized count of validations. --- **`_ValueCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[RunStepField]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`allowNotApplicable`**: `Boolean!` --- **`allowedIonType`**: `runstepfieldiontypeentitytypeenum` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`batchAdoptedSiblings`**: `[RunStepField]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[RunStepField]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`display`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`helpText`**: `String` --- **`id`**: `Int!` --- **`ionValue`**: `IonType` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`notApplicable`**: `Boolean!` --- **`options`**: `[String]` --- **`originField`**: `StepField` **Arguments:** - `filters`: `FieldsInputFilters` --- **`originFieldId`**: `Int` --- **`part`**: `Part` Return part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` Return part foreign key relation. --- **`partInventory`**: `PartInventory` Return part inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` Return part inventory foreign key relation. --- **`partSubtype`**: `PartSubtype` Return part subtype relationship. **Arguments:** - `filters`: `PartSubtypesInputFilters` --- **`partSubtypeId`**: `Int` Return part subtype foreign key relation. --- **`peerReviewRequired`**: `Boolean!` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`required`**: `Boolean!` --- **`runStepId`**: `Int` --- **`settable`**: `Boolean` --- **`signoffRole`**: `Role` Get Role for signoff. Returns: relationship object **Arguments:** - `filters`: `RolesInputFilters` --- **`signoffRoleId`**: `Int` --- **`step`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepFieldEventFilter` --- **`type`**: `runstepfieldfieldtypes` --- **`unit`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id --- **`valid`**: `Boolean` --- **`validations`**: `[RunStepFieldValidation]` **Arguments:** - `filters`: `RunStepFieldValidationsInputFilters` --- **`value`**: `ScalarValue` ## Examples ```graphql Query query RunStepField($id: ID!) { runStepField(id: $id) { LastSessionId _AssigneesCount _IonValueCount _ValidationsCount _ValueCount _created } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "runStepField": { "LastSessionId": "string", "_AssigneesCount": 1, "_IonValueCount": 1, "_ValidationsCount": 1, "_ValueCount": 1, "_created": "value" } } } ``` # runStepFieldValidation Source: https://docs.firstresonance.io/api-reference/queries/runStepFieldValidation Retrieves an item by its ID. **query** `runStepFieldValidation(id: ID!): RunStepFieldValidation` ## Arguments **`id`**: `ID!` (required) ## Returns `RunStepFieldValidation` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[RunStepFieldValidation]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchAdoptedSiblings`**: `[RunStepFieldValidation]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[RunStepFieldValidation]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`function`**: `ValidationFunction` Return function related to validation object. **Arguments:** - `filters`: `ValidationFunctionsInputFilters` --- **`functionId`**: `Int!` Return foriegn key relation from validation to function. --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`result`**: `Validationresultenum!` --- **`runStepField`**: `RunStepField` **Arguments:** - `filters`: `RunStepFieldInputFilters` --- **`runStepFieldId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepFieldValidationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`validation`**: `StepFieldValidation` **Arguments:** - `filters`: `StepFieldValidationsInputFilters` --- **`validationId`**: `Int` --- **`value`**: `Float` ## Examples ```graphql Query query RunStepFieldValidation($id: ID!) { runStepFieldValidation(id: $id) { LastSessionId _created _etag _updated allBatchedSiblings { __typename } batchAdoptedSiblings { __typename } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "runStepFieldValidation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "RunStepFieldValidation" } ], "batchAdoptedSiblings": [ { "__typename": "RunStepFieldValidation" } ] } } } ``` # runStepFieldValidations Source: https://docs.firstresonance.io/api-reference/queries/runStepFieldValidations Retrieves a list of items. **query** `runStepFieldValidations(after: String, before: String, distinctOn: [RunStepFieldValidationSortEnum], filters: RunStepFieldValidationsInputFilters, first: Int, last: Int, sort: [RunStepFieldValidationSortEnum]): RunStepFieldValidationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RunStepFieldValidationSortEnum]` --- **`filters`**: `RunStepFieldValidationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RunStepFieldValidationSortEnum]` ## Returns `RunStepFieldValidationsConnection` **`edges`**: `[RunStepFieldValidationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RunStepFieldValidations { runStepFieldValidations { edges { cursor node { LastSessionId _created _etag _updated allBatchedSiblings { __typename } batchAdoptedSiblings { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "runStepFieldValidations": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "allBatchedSiblings": [ { "__typename": "RunStepFieldValidation" } ], "batchAdoptedSiblings": [ { "__typename": "RunStepFieldValidation" } ] } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # runStepFields Source: https://docs.firstresonance.io/api-reference/queries/runStepFields Retrieves a list of items. **query** `runStepFields(after: String, before: String, distinctOn: [RunStepFieldSortEnum], filters: RunStepFieldInputFilters, first: Int, last: Int, sort: [RunStepFieldSortEnum]): RunStepFieldsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RunStepFieldSortEnum]` --- **`filters`**: `RunStepFieldInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RunStepFieldSortEnum]` ## Returns `RunStepFieldsConnection` **`edges`**: `[RunStepFieldsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RunStepFields { runStepFields { edges { cursor node { LastSessionId _AssigneesCount _IonValueCount _ValidationsCount _ValueCount _created } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "runStepFields": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_IonValueCount": 1, "_ValidationsCount": 1, "_ValueCount": 1, "_created": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # runSteps Source: https://docs.firstresonance.io/api-reference/queries/runSteps Retrieves a list of items. **query** `runSteps(after: String, before: String, distinctOn: [RunStepSortEnum], filters: RunStepsInputFilters, first: Int, last: Int, sort: [RunStepSortEnum]): RunsStepsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RunStepSortEnum]` --- **`filters`**: `RunStepsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RunStepSortEnum]` ## Returns `RunsStepsConnection` **`edges`**: `[RunsStepsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query RunSteps { runSteps { edges { cursor node { Attributes { __typename } Parent Sessions { __typename } _AbomInstallationsCount _AllChildrenCount _AllParentsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "runSteps": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "RunStepAttribute" } ], "Parent": "string", "Sessions": [ { "__typename": "SessionEvent" } ], "_AbomInstallationsCount": 1, "_AllChildrenCount": 1, "_AllParentsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # runs Source: https://docs.firstresonance.io/api-reference/queries/runs Retrieves a list of items. **query** `runs(after: String, before: String, distinctOn: [RunSortEnum], filters: RunsInputFilters, first: Int, last: Int, sort: [RunSortEnum]): RunsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[RunSortEnum]` --- **`filters`**: `RunsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[RunSortEnum]` ## Returns `RunsConnection` **`edges`**: `[RunsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Runs { runs { edges { cursor node { Attributes { __typename } ExportControlled LastSessionId _AssigneesCount _AttributedPartsCount _AttributedUsersCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "runs": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "RunAttribute" } ], "ExportControlled": true, "LastSessionId": "string", "_AssigneesCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # scanBarcode Source: https://docs.firstresonance.io/api-reference/queries/scanBarcode Scans a barcode and returns the associated object. **query** `scanBarcode(barcode: String!, context: ScanContext): ScanBarcode` ## Arguments **`barcode`**: `String!` (required) --- **`context`**: `ScanContext` ## Returns `ScanBarcode` **`entities`**: `[Entity]` ## Examples ```graphql Query query ScanBarcode($barcode: String!) { scanBarcode(barcode: $barcode) { entities { Updated assets { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } barcodeLabels { LastSessionId _BarcodePrintRequestsCount _LocationCount _PartInventoryCount _PartKitCount _RunCount } comments { LastSessionId _RepliesCount _RunCount _RunStepCount _created _etag } fileAttachments { LastSessionId _AssetEntitiesCount _FileAttachmentEntitiesCount _created _etag _updated } id } } } ``` ```json Variables { "barcode": "string" } ``` ```json Response { "data": { "scanBarcode": { "entities": [ { "Updated": "value", "assets": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "barcodeLabels": [ { "LastSessionId": "string", "_BarcodePrintRequestsCount": 1, "_LocationCount": 1, "_PartInventoryCount": 1, "_PartKitCount": 1, "_RunCount": 1 } ], "comments": [ { "LastSessionId": "string", "_RepliesCount": 1, "_RunCount": 1, "_RunStepCount": 1, "_created": "value", "_etag": "string" } ], "fileAttachments": [ { "LastSessionId": "string", "_AssetEntitiesCount": 1, "_FileAttachmentEntitiesCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } ], "id": 1.5 } ] } } } ``` # searchTools Source: https://docs.firstresonance.io/api-reference/queries/searchTools **query** `searchTools(after: String, before: String, first: Int, input: SearchToolsInput!, last: Int, sort: [PartInventorySortEnum]): ToolConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`first`**: `Int` --- **`input`**: `SearchToolsInput!` (required) --- **`last`**: `Int` --- **`sort`**: `[PartInventorySortEnum]` ## Returns `ToolConnection` **`edges`**: `[ToolEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. ## Examples ```graphql Query query SearchTools($input: SearchToolsInput!) { searchTools(input: $input) { edges { cursor node { Attributes { __typename } Cost LastSessionId _AbomInstallationsCount _AttributedPartsCount _AttributedUsersCount } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor } } } ``` ```json Variables { "input": { "maintenanceStatuses": [ "AVAILABLE" ], "searchTerm": "string" } } ``` ```json Response { "data": { "searchTools": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "PartInventoryAttribute" } ], "Cost": 1.5, "LastSessionId": "string", "_AbomInstallationsCount": 1, "_AttributedPartsCount": 1, "_AttributedUsersCount": 1 } } ], "pageInfo": { "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string" } } } } ``` # session Source: https://docs.firstresonance.io/api-reference/queries/session Retrieves an item by its ID. **query** `session(id: ID!): Session` ## Arguments **`id`**: `ID!` (required) ## Returns `Session` **`Created`**: `DateTime` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_etag`**: `String` --- **`checkIn`**: `DateTime!` --- **`checkOut`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`duration`**: `Float` --- **`eventType`**: `Eventtypeenum!` --- **`id`**: `Int!` --- **`isValidGrouping`**: `Boolean` --- **`prettyStr`**: `String` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SessionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Session($id: ID!) { session(id: $id) { Created LastSessionId Updated _etag checkIn checkOut } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "session": { "Created": "value", "LastSessionId": "string", "Updated": "value", "_etag": "string", "checkIn": "value", "checkOut": "value" } } } ``` # sessions Source: https://docs.firstresonance.io/api-reference/queries/sessions Retrieves a list of items. **query** `sessions(after: String, before: String, distinctOn: [SessionSortEnum], filters: SessionsInputFilters, first: Int, last: Int, sort: [SessionSortEnum]): SessionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[SessionSortEnum]` --- **`filters`**: `SessionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[SessionSortEnum]` ## Returns `SessionsConnection` **`edges`**: `[SessionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Sessions { sessions { edges { cursor node { Created LastSessionId Updated _etag checkIn checkOut } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "sessions": { "edges": [ { "cursor": "string", "node": { "Created": "value", "LastSessionId": "string", "Updated": "value", "_etag": "string", "checkIn": "value", "checkOut": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # snapshotExportJob Source: https://docs.firstresonance.io/api-reference/queries/snapshotExportJob Retrieves an item by its ID. **query** `snapshotExportJob(id: ID!): SnapshotExportJob` ## Arguments **`id`**: `ID!` (required) ## Returns `SnapshotExportJob` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`destination`**: `SnapshotExportJobDestination!` --- **`downloadUrls`**: `[SnapshotExportJobFile]` --- **`errors`**: `JSONString!` --- **`exportDuration`**: `Int` --- **`exportFiles`**: `JSONString!` --- **`exportOptions`**: `JSONString!` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`fileSizeBytes`**: `Float` --- **`filename`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`status`**: `SnapshotExportJobStatus!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SnapshotExportJobEventFilter` --- **`totalSizeBytes`**: `String` --- **`type`**: `Snapshotexportjobtypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query SnapshotExportJob($id: ID!) { snapshotExportJob(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "snapshotExportJob": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # snapshotExportJobs Source: https://docs.firstresonance.io/api-reference/queries/snapshotExportJobs Retrieves a list of items. **query** `snapshotExportJobs(after: String, before: String, distinctOn: [SnapshotExportJobSortEnum], filters: SnapshotExportJobsInputFilters, first: Int, last: Int, sort: [SnapshotExportJobSortEnum]): SnapshotExportJobsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[SnapshotExportJobSortEnum]` --- **`filters`**: `SnapshotExportJobsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[SnapshotExportJobSortEnum]` ## Returns `SnapshotExportJobsConnection` **`edges`**: `[SnapshotExportJobsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query SnapshotExportJobs { snapshotExportJobs { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "snapshotExportJobs": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # step Source: https://docs.firstresonance.io/api-reference/queries/step Retrieves an item by its ID. **query** `step(id: ID!): Step` ## Arguments **`id`**: `ID!` (required) ## Returns `Step` **`Attributes`**: `[StepAttribute]` **Arguments:** - `filters`: `StepAttributesInputFilters` --- **`Parent`**: `String` --- **`_AllChildrenCount`**: `Int` --- **`_AllParentsCount`**: `Int` --- **`_AncestorStepsCount`**: `Int` Optimized count of ancestorSteps. --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_DatagridColumnsCount`**: `Int` Optimized count of datagridColumns. --- **`_DatagridRowsCount`**: `Int` Optimized count of datagridRows. --- **`_DerivedStepsCount`**: `Int` Optimized count of derivedSteps. --- **`_DescendantStepsCount`**: `Int` Optimized count of descendantSteps. --- **`_DownstreamCount`**: `Int` Optimized count of downstream. --- **`_FieldsCount`**: `Int` Optimized count of fields. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_ProcedureApprovalsCount`**: `Int` Optimized count of procedureApprovals. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReviewsCount`**: `Int` Optimized count of reviews. --- **`_RoleBasedApprovalRequestsCount`**: `Int` Optimized count of roleBasedApprovalRequests. --- **`_RoleBasedApprovalsCount`**: `Int` Optimized count of roleBasedApprovals. --- **`_StepPartRequirementsCount`**: `Int` Optimized count of stepPartRequirements. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_UpstreamCount`**: `Int` Optimized count of upstream. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allChildren`**: `[Step]` --- **`allParents`**: `[Step]` --- **`ancestorSteps`**: `[Step]` --- **`approvalRequests`**: `[StepApprovalRequest]` **Arguments:** - `filters`: `StepApprovalRequestsInputFilters` --- **`approvals`**: `[StepApproval]` **Arguments:** - `filters`: `StepApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`assets`**: `[FileAttachment]` --- **`attributedParts`**: `[StepAttributedPart]` **Arguments:** - `filters`: `StepAttributedPartsInputFilters` --- **`attributedUsers`**: `[StepAttributedUser]` **Arguments:** - `filters`: `StepAttributedUsersInputFilters` --- **`attributes`**: `[StepAttribute]` --- **`content`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`datagrid`**: `DataGrid` > Deprecated: Deprecated --- **`datagridColumns`**: `DatagridColumnsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridColumnsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridColumnSortEnum]` --- **`datagridRows`**: `DatagridRowsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridRowsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridRowSortEnum]` --- **`derivedSteps`**: `[Step]` --- **`descendantSteps`**: `[Step]` --- **`displayPdf`**: `Boolean!` --- **`downstream`**: `[StepsEdge]` **Arguments:** - `filters`: `StepsEdgesInputFilters` --- **`downstreamStepIds`**: `[Int]` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`executionEvidence`**: `StepExecutionEvidence` **Arguments:** - `feedbackLimit`: `Int` - `notableLimit`: `Int` - `recentLimit`: `Int` --- **`familyId`**: `Int!` Get column with related family id. This value serves as a "group id" for different versions of the "same" model object. For example, all versions of a standard step will have the same family_id. If a step is not a standard step, this will just equal the value of the step's id. Returns: Column instance --- **`fieldCount`**: `Int` --- **`fields`**: `[StepField]` **Arguments:** - `filters`: `FieldsInputFilters` --- **`fullPosition`**: `String` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` Define intent option relationship. **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isChildStandardStep`**: `Boolean` --- **`isDerivedStep`**: `Boolean` --- **`isLatestReleasedVersion`**: `Boolean` --- **`isLatestVersion`**: `Boolean` --- **`isOutsideProcess`**: `Boolean!` --- **`isRoleBased`**: `Boolean!` --- **`isStandardStep`**: `Boolean` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`leadTime`**: `Int` --- **`location`**: `Location` Return location relationship. **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` Return location foreign key. --- **`locationSubtype`**: `LocationSubtype` **Arguments:** - `filters`: `LocationSubtypesInputFilters` --- **`locationSubtypeId`**: `Int` --- **`originStep`**: `Step` --- **`originStepId`**: `Int` Return step id from which a copied step originated. --- **`pages`**: `[Int]` --- **`parent`**: `Step` --- **`parentId`**: `Int` Return self referential parent foreign key. --- **`parentIds`**: `[Int]` --- **`pdf`**: `FileAttachment` Return pdf relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`pdfAssetId`**: `Int` Return pdf foreign key. --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureApprovals`**: `[ProcedureApproval]` **Arguments:** - `filters`: `ProcedureApprovalsInputFilters` --- **`procedureId`**: `Int` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`reviews`**: `[Review]` **Arguments:** - `filters`: `ReviewsInputFilters` --- **`roleBasedApprovalRequests`**: `[StepRoleBasedApprovalRequest]` **Arguments:** - `filters`: `StepRoleBasedApprovalRequestsInputFilters` --- **`roleBasedApprovals`**: `[StepRoleBasedApproval]` **Arguments:** - `filters`: `StepRoleBasedApprovalsInputFilters` --- **`slateContent`**: `SlateContent` --- **`sourceStep`**: `Step` --- **`standardStep`**: `Step` --- **`standardStepFamilyId`**: `Int` --- **`standardStepId`**: `Int` --- **`standardStepProcedureCount`**: `Int` --- **`standardStepProcedures`**: `[Procedure]` --- **`standardStepRunCount`**: `Int` --- **`standardStepRuns`**: `[Run]` --- **`standardStepStatus`**: `Standardstepstatusenum` --- **`stepPartRequirements`**: `[StepPartRequirement]` --- **`steps`**: `[Step]` --- **`stepsCount`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepEventFilter` --- **`title`**: `String!` --- **`type`**: `Steptypes!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstream`**: `[StepsEdge]` **Arguments:** - `filters`: `StepsEdgesInputFilters` --- **`upstreamStepIds`**: `[Int]` --- **`version`**: `Int!` ## Examples ```graphql Query query Step($id: ID!) { step(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "step": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } } ``` # stepApproval Source: https://docs.firstresonance.io/api-reference/queries/stepApproval Retrieves an item by its ID. **query** `stepApproval(id: ID!): StepApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `StepApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `StepApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[StepApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query StepApproval($id: ID!) { stepApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # stepApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/stepApprovalRequest Retrieves an item by its ID. **query** `stepApprovalRequest(id: ID!): StepApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `StepApprovalRequest` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query StepApprovalRequest($id: ID!) { stepApprovalRequest(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepApprovalRequest": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # stepApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/stepApprovalRequests Retrieves a list of items. **query** `stepApprovalRequests(after: String, before: String, distinctOn: [StepApprovalRequestSortEnum], filters: StepApprovalRequestsInputFilters, first: Int, last: Int, sort: [StepApprovalRequestSortEnum]): StepApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepApprovalRequestSortEnum]` --- **`filters`**: `StepApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepApprovalRequestSortEnum]` ## Returns `StepApprovalRequestsConnection` **`edges`**: `[StepApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepApprovalRequests { stepApprovalRequests { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepApprovalRoles Source: https://docs.firstresonance.io/api-reference/queries/stepApprovalRoles Retrieves a list of items. **query** `stepApprovalRoles(after: String, before: String, distinctOn: [StepApprovalRoleSortEnum], filters: StepApprovalRolesInputFilters, first: Int, last: Int, sort: [StepApprovalRoleSortEnum]): StepApprovalRolesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepApprovalRoleSortEnum]` --- **`filters`**: `StepApprovalRolesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepApprovalRoleSortEnum]` ## Returns `StepApprovalRolesConnection` **`edges`**: `[StepApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepApprovalRoles { stepApprovalRoles { edges { cursor node { LastSessionId _created _etag _updated count createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepApprovalRoles": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "count": 1, "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepApprovals Source: https://docs.firstresonance.io/api-reference/queries/stepApprovals Retrieves a list of items. **query** `stepApprovals(after: String, before: String, distinctOn: [StepApprovalSortEnum], filters: StepApprovalsInputFilters, first: Int, last: Int, sort: [StepApprovalSortEnum]): StepApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepApprovalSortEnum]` --- **`filters`**: `StepApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepApprovalSortEnum]` ## Returns `StepApprovalsConnection` **`edges`**: `[StepApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepApprovals { stepApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepEdge Source: https://docs.firstresonance.io/api-reference/queries/stepEdge Retrieves an item by its ID. **query** `stepEdge(id: ID!): StepsEdge` ## Arguments **`id`**: `ID!` (required) ## Returns `StepsEdge` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepsEdgeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstreamStep`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`upstreamStepId`**: `Int` ## Examples ```graphql Query query StepEdge($id: ID!) { stepEdge(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepEdge": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # stepField Source: https://docs.firstresonance.io/api-reference/queries/stepField Retrieves an item by its ID. **query** `stepField(id: ID!): StepField` ## Arguments **`id`**: `ID!` (required) ## Returns `StepField` **`LastSessionId`**: `String` --- **`_ValidationsCount`**: `Int` Optimized count of validations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allowNotApplicable`**: `Boolean!` --- **`allowedIonType`**: `stepfieldiontypeentitytypeenum` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`display`**: `String` --- **`editable`**: `Boolean` --- **`helpText`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`options`**: `[String]` --- **`part`**: `Part` Return part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` Return part foreign key relation. --- **`partSubtype`**: `PartSubtype` Return part subtype relationship. **Arguments:** - `filters`: `PartSubtypesInputFilters` --- **`partSubtypeId`**: `Int` Return part subtype foreign key relation. --- **`peerReviewRequired`**: `Boolean!` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`required`**: `Boolean!` --- **`signoffRole`**: `Role` Get Role for signoff. Returns: relationship object **Arguments:** - `filters`: `RolesInputFilters` --- **`signoffRoleId`**: `Int` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepFieldEventFilter` --- **`type`**: `Fieldtypes!` --- **`unit`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`validations`**: `[StepFieldValidation]` **Arguments:** - `filters`: `StepFieldValidationsInputFilters` ## Examples ```graphql Query query StepField($id: ID!) { stepField(id: $id) { LastSessionId _ValidationsCount _created _etag _updated allowNotApplicable } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepField": { "LastSessionId": "string", "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "allowNotApplicable": true } } } ``` # stepFieldValidation Source: https://docs.firstresonance.io/api-reference/queries/stepFieldValidation Retrieves an item by its ID. **query** `stepFieldValidation(id: ID!): StepFieldValidation` ## Arguments **`id`**: `ID!` (required) ## Returns `StepFieldValidation` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`field`**: `StepField` **Arguments:** - `filters`: `FieldsInputFilters` --- **`fieldId`**: `Int` --- **`function`**: `ValidationFunction` Return function related to validation object. **Arguments:** - `filters`: `ValidationFunctionsInputFilters` --- **`functionId`**: `Int!` Return foriegn key relation from validation to function. --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepFieldValidationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `Float` ## Examples ```graphql Query query StepFieldValidation($id: ID!) { stepFieldValidation(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepFieldValidation": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # stepFieldValidations Source: https://docs.firstresonance.io/api-reference/queries/stepFieldValidations Retrieves a list of items. **query** `stepFieldValidations(after: String, before: String, distinctOn: [StepFieldValidationSortEnum], filters: StepFieldValidationsInputFilters, first: Int, last: Int, sort: [StepFieldValidationSortEnum]): StepFieldValidationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepFieldValidationSortEnum]` --- **`filters`**: `StepFieldValidationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepFieldValidationSortEnum]` ## Returns `StepFieldValidationsConnection` **`edges`**: `[StepFieldValidationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepFieldValidations { stepFieldValidations { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepFieldValidations": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepPartRequirement Source: https://docs.firstresonance.io/api-reference/queries/stepPartRequirement Retrieves an item by its ID. **query** `stepPartRequirement(id: ID!): StepPartRequirement` ## Arguments **`id`**: `ID!` (required) ## Returns `StepPartRequirement` **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_AssignedReferenceDesignatorsCount`**: `Int` Optimized count of assignedReferenceDesignators. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReferenceDesignatorAssignmentsCount`**: `Int` Optimized count of referenceDesignatorAssignments. --- **`_ReferenceDesignatorsCount`**: `Int` Optimized count of referenceDesignators. --- **`_RunStepBuildRequirementsCount`**: `Int` Optimized count of runStepBuildRequirements. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedReferenceDesignators`**: `[MBomItemReferenceDesignator]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`procedureId`**: `Int!` --- **`procedureMbom`**: `ProcedureMBom` --- **`procedureMbomItem`**: `ProcedureMBomItem` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`quantity`**: `Float!` --- **`referenceDesignators`**: `[MBomItemReferenceDesignator]` --- **`runStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query StepPartRequirement($id: ID!) { stepPartRequirement(id: $id) { Deleted LastSessionId _AssignedReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _ReferenceDesignatorsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepPartRequirement": { "Deleted": true, "LastSessionId": "string", "_AssignedReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_ReferenceDesignatorsCount": 1 } } } ``` # stepPartRequirements Source: https://docs.firstresonance.io/api-reference/queries/stepPartRequirements Retrieves a list of items. **query** `stepPartRequirements(after: String, before: String, distinctOn: [StepPartRequirementSortEnum], filters: StepPartRequirementsInputFilters, first: Int, last: Int, sort: [StepPartRequirementSortEnum]): StepPartRequirementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepPartRequirementSortEnum]` --- **`filters`**: `StepPartRequirementsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepPartRequirementSortEnum]` ## Returns `StepPartRequirementsConnection` **`edges`**: `[StepPartRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepPartRequirements { stepPartRequirements { edges { cursor node { Deleted LastSessionId _AssignedReferenceDesignatorsCount _ProcedureReferenceDesignatorsCount _ReferenceDesignatorAssignmentsCount _ReferenceDesignatorsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepPartRequirements": { "edges": [ { "cursor": "string", "node": { "Deleted": true, "LastSessionId": "string", "_AssignedReferenceDesignatorsCount": 1, "_ProcedureReferenceDesignatorsCount": 1, "_ReferenceDesignatorAssignmentsCount": 1, "_ReferenceDesignatorsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepProposal Source: https://docs.firstresonance.io/api-reference/queries/stepProposal Retrieves an item by its ID. **query** `stepProposal(id: ID!): StepProposal` ## Arguments **`id`**: `ID!` (required) ## Returns `StepProposal` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`acceptedEtag`**: `String` --- **`applicationPreview`**: `StepProposalApplicationPreview` Current result and applicability of accepting the proposal. --- **`baseEtag`**: `String!` --- **`changeSummary`**: `String!` --- **`clearedAt`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`proposedContent`**: `String` --- **`proposedSlateContent`**: `SlateContent` --- **`proposedTitle`**: `String` --- **`replacedContent`**: `String` --- **`replacedSlateContent`**: `SlateContent` --- **`replacedTitle`**: `String` --- **`state`**: `Stepproposalstateenum!` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`supersedes`**: `StepProposal` --- **`supersedesId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepProposalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query StepProposal($id: ID!) { stepProposal(id: $id) { LastSessionId _created _etag _updated acceptedEtag applicationPreview { applicable conflictMessage content slateContent title } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepProposal": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "applicable": true, "conflictMessage": "string", "content": "string", "slateContent": "value", "title": "string" } } } } ``` # stepProposals Source: https://docs.firstresonance.io/api-reference/queries/stepProposals Retrieves a list of items. **query** `stepProposals(after: String, before: String, distinctOn: [StepProposalSortEnum], filters: StepProposalsInputFilters, first: Int, last: Int, sort: [StepProposalSortEnum]): StepProposalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepProposalSortEnum]` --- **`filters`**: `StepProposalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepProposalSortEnum]` ## Returns `StepProposalsConnection` **`edges`**: `[StepProposalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepProposals { stepProposals { edges { cursor node { LastSessionId _created _etag _updated acceptedEtag applicationPreview { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepProposals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "acceptedEtag": "string", "applicationPreview": { "__typename": "StepProposalApplicationPreview" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/queries/stepRoleBasedApproval Retrieves an item by its ID. **query** `stepRoleBasedApproval(id: ID!): StepRoleBasedApproval` ## Arguments **`id`**: `ID!` (required) ## Returns `StepRoleBasedApproval` **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Stepapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `StepRoleBasedApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[StepRoleBasedApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepRoleBasedApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query StepRoleBasedApproval($id: ID!) { stepRoleBasedApproval(id: $id) { LastSessionId _RepliesCount _created _etag _updated comment } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepRoleBasedApproval": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } } ``` # stepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/queries/stepRoleBasedApprovalRequest Retrieves an item by its ID. **query** `stepRoleBasedApprovalRequest(id: ID!): StepRoleBasedApprovalRequest` ## Arguments **`id`**: `ID!` (required) ## Returns `StepRoleBasedApprovalRequest` **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Stepapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepRoleBasedApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query StepRoleBasedApprovalRequest($id: ID!) { stepRoleBasedApprovalRequest(id: $id) { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "stepRoleBasedApprovalRequest": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } } ``` # stepRoleBasedApprovalRequests Source: https://docs.firstresonance.io/api-reference/queries/stepRoleBasedApprovalRequests Retrieves a list of items. **query** `stepRoleBasedApprovalRequests(after: String, before: String, distinctOn: [StepRoleBasedApprovalRequestSortEnum], filters: StepRoleBasedApprovalRequestsInputFilters, first: Int, last: Int, sort: [StepRoleBasedApprovalRequestSortEnum]): StepRoleBasedApprovalRequestsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepRoleBasedApprovalRequestSortEnum]` --- **`filters`**: `StepRoleBasedApprovalRequestsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepRoleBasedApprovalRequestSortEnum]` ## Returns `StepRoleBasedApprovalRequestsConnection` **`edges`**: `[StepRoleBasedApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepRoleBasedApprovalRequests { stepRoleBasedApprovalRequests { edges { cursor node { LastSessionId _AssigneesCount _created _etag _updated assignedTeam { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepRoleBasedApprovalRequests": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_AssigneesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "assignedTeam": { "__typename": "Team" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # stepRoleBasedApprovals Source: https://docs.firstresonance.io/api-reference/queries/stepRoleBasedApprovals Retrieves a list of items. **query** `stepRoleBasedApprovals(after: String, before: String, distinctOn: [StepRoleBasedApprovalSortEnum], filters: StepRoleBasedApprovalsInputFilters, first: Int, last: Int, sort: [StepRoleBasedApprovalSortEnum]): StepRoleBasedApprovalsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepRoleBasedApprovalSortEnum]` --- **`filters`**: `StepRoleBasedApprovalsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepRoleBasedApprovalSortEnum]` ## Returns `StepRoleBasedApprovalsConnection` **`edges`**: `[StepRoleBasedApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query StepRoleBasedApprovals { stepRoleBasedApprovals { edges { cursor node { LastSessionId _RepliesCount _created _etag _updated comment } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "stepRoleBasedApprovals": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RepliesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "comment": "string" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # steps Source: https://docs.firstresonance.io/api-reference/queries/steps Retrieves a list of items. **query** `steps(after: String, before: String, distinctOn: [StepSortEnum], filters: StepsFilters, first: Int, last: Int, sort: [StepSortEnum]): ProcedureStepsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[StepSortEnum]` --- **`filters`**: `StepsFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[StepSortEnum]` ## Returns `ProcedureStepsConnection` **`edges`**: `[ProcedureStepsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Steps { steps { edges { cursor node { Attributes { __typename } Parent _AllChildrenCount _AllParentsCount _AncestorStepsCount _ApprovalRequestsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "steps": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "StepAttribute" } ], "Parent": "string", "_AllChildrenCount": 1, "_AllParentsCount": 1, "_AncestorStepsCount": 1, "_ApprovalRequestsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # supplier Source: https://docs.firstresonance.io/api-reference/queries/supplier Retrieves an item by its ID. **query** `supplier(id: ID!): Supplier` ## Arguments **`id`**: `ID!` (required) ## Returns `Supplier` **`Attributes`**: `[SupplierAttribute]` **Arguments:** - `filters`: `SupplierAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartsInventoriesCount`**: `Int` Optimized count of partsInventories. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_PurchaseOrdersCount`**: `Int` Optimized count of purchaseOrders. --- **`_SupplierPartsCount`**: `Int` Optimized count of supplierParts. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`address`**: `String` --- **`attributedParts`**: `[SupplierAttributedPart]` **Arguments:** - `filters`: `SupplierAttributedPartsInputFilters` --- **`attributedUsers`**: `[SupplierAttributedUser]` **Arguments:** - `filters`: `SupplierAttributedUsersInputFilters` --- **`attributes`**: `[SupplierAttribute]` --- **`comments`**: `[Comment]` --- **`contactName`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`email`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`partsInventories`**: `[PartInventory]` --- **`phoneNumber`**: `String` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`purchaseOrders`**: `[PurchaseOrder]` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`supplierParts`**: `[SupplierPart]` **Arguments:** - `filters`: `SupplierPartsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SupplierEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query Supplier($id: ID!) { supplier(id: $id) { Attributes { Created Etag LastSessionId Updated _IonValueCount _ValueCount } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "supplier": { "Attributes": [ { "Created": "value", "Etag": "string", "LastSessionId": "string", "Updated": "value", "_IonValueCount": 1, "_ValueCount": 1 } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } } ``` # supplierPart Source: https://docs.firstresonance.io/api-reference/queries/supplierPart Retrieves an item by its ID. **query** `supplierPart(id: ID!): SupplierPart` ## Arguments **`id`**: `ID!` (required) ## Returns `SupplierPart` **`LastSessionId`**: `String` --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`conversionFactor`**: `Float!` --- **`cost`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int!` --- **`supplierPartNumber`**: `String!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SupplierPartEventFilter` --- **`unitOfMeasure`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query SupplierPart($id: ID!) { supplierPart(id: $id) { LastSessionId _PurchaseOrderLinesCount _created _etag _updated conversionFactor } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "supplierPart": { "LastSessionId": "string", "_PurchaseOrderLinesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "conversionFactor": 1.5 } } } ``` # supplierParts Source: https://docs.firstresonance.io/api-reference/queries/supplierParts Retrieves a list of items. **query** `supplierParts(after: String, before: String, distinctOn: [SupplierPartSortEnum], filters: SupplierPartsInputFilters, first: Int, last: Int, sort: [SupplierPartSortEnum]): SupplierPartsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[SupplierPartSortEnum]` --- **`filters`**: `SupplierPartsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[SupplierPartSortEnum]` ## Returns `SupplierPartsConnection` **`edges`**: `[SupplierPartsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query SupplierParts { supplierParts { edges { cursor node { LastSessionId _PurchaseOrderLinesCount _created _etag _updated conversionFactor } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "supplierParts": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_PurchaseOrderLinesCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "conversionFactor": 1.5 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # suppliers Source: https://docs.firstresonance.io/api-reference/queries/suppliers Retrieves a list of items. **query** `suppliers(after: String, before: String, distinctOn: [SupplierSortEnum], filters: SuppliersInputFilters, first: Int, last: Int, sort: [SupplierSortEnum]): SuppliersConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[SupplierSortEnum]` --- **`filters`**: `SuppliersInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[SupplierSortEnum]` ## Returns `SuppliersConnection` **`edges`**: `[SuppliersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Suppliers { suppliers { edges { cursor node { Attributes { __typename } LastSessionId _AttributedPartsCount _AttributedUsersCount _AttributesCount _CommentsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "suppliers": { "edges": [ { "cursor": "string", "node": { "Attributes": [ { "__typename": "SupplierAttribute" } ], "LastSessionId": "string", "_AttributedPartsCount": 1, "_AttributedUsersCount": 1, "_AttributesCount": 1, "_CommentsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # team Source: https://docs.firstresonance.io/api-reference/queries/team Retrieves an item by its ID. **query** `team(id: ID!): Team` ## Arguments **`id`**: `ID!` (required) ## Returns `Team` **`LastSessionId`**: `String` --- **`_RolesCount`**: `Int` Optimized count of roles. --- **`_TeamRolesCount`**: `Int` Optimized count of teamRoles. --- **`_TeamUsersCount`**: `Int` Optimized count of teamUsers. --- **`_UsersCount`**: `Int` Optimized count of users. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deactivated`**: `Boolean` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` --- **`supervisor`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`supervisorId`**: `Int` --- **`teamRoles`**: `[TeamRole]` **Arguments:** - `filters`: `TeamRolesInputFilters` --- **`teamUsers`**: `[TeamUser]` **Arguments:** - `filters`: `TeamUsersInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `TeamEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`users`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` ## Examples ```graphql Query query Team($id: ID!) { team(id: $id) { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "team": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } } ``` # teams Source: https://docs.firstresonance.io/api-reference/queries/teams Retrieves a list of items. **query** `teams(after: String, before: String, distinctOn: [TeamSortEnum], filters: TeamsInputFilters, first: Int, last: Int, sort: [TeamSortEnum]): TeamsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[TeamSortEnum]` --- **`filters`**: `TeamsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[TeamSortEnum]` ## Returns `TeamsConnection` **`edges`**: `[TeamsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Teams { teams { edges { cursor node { LastSessionId _RolesCount _TeamRolesCount _TeamUsersCount _UsersCount _created } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "teams": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_RolesCount": 1, "_TeamRolesCount": 1, "_TeamUsersCount": 1, "_UsersCount": 1, "_created": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # unitOfMeasurement Source: https://docs.firstresonance.io/api-reference/queries/unitOfMeasurement Retrieves an item by its ID. **query** `unitOfMeasurement(id: ID!): UnitOfMeasurement` ## Arguments **`id`**: `ID!` (required) ## Returns `UnitOfMeasurement` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id of creator related to Enum. Returns: int of id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UnitOfMeasurementEventFilter` --- **`type`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id of updater related to Enum. Returns: int of id ## Examples ```graphql Query query UnitOfMeasurement($id: ID!) { unitOfMeasurement(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "unitOfMeasurement": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # unitsOfMeasurement Source: https://docs.firstresonance.io/api-reference/queries/unitsOfMeasurement Retrieves a list of items. **query** `unitsOfMeasurement(after: String, before: String, distinctOn: [UnitOfMeasurementSortEnum], filters: UnitsOfMeasurementInputFilters, first: Int, last: Int, sort: [UnitOfMeasurementSortEnum]): UnitOfMeasurementsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[UnitOfMeasurementSortEnum]` --- **`filters`**: `UnitsOfMeasurementInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[UnitOfMeasurementSortEnum]` ## Returns `UnitOfMeasurementsConnection` **`edges`**: `[UnitOfMeasurementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query UnitsOfMeasurement { unitsOfMeasurement { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "unitsOfMeasurement": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # user Source: https://docs.firstresonance.io/api-reference/queries/user Retrieves an item by its ID. **query** `user(id: ID!): User` ## Arguments **`id`**: `ID!` (required) ## Returns `User` **`LastSessionId`**: `String` --- **`Organization`**: `Organization` > Deprecated: Use `organization` instead, `Organization` is deprecated. --- **`_ActiveSessionsCount`**: `Int` Optimized count of active sessions. --- **`_AnalyticsCredentialCount`**: `Int` Optimized count of analyticsCredential. --- **`_ApiKeysCount`**: `Int` Optimized count of apiKeys. --- **`_PermissionGroupsCount`**: `Int` Optimized count of permissionGroups. --- **`_RolesCount`**: `Int` Optimized count of Roles. --- **`_TeamsCount`**: `Int` Optimized count of teams. --- **`_UpdatedByCount`**: `Int` Optimized count of updatedBy. --- **`_UserRolesCount`**: `Int` Optimized count of userRoles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`activeSessions`**: `[Session]` **Arguments:** - `filters`: `SessionsInputFilters` --- **`avatar`**: `String` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`deactivated`**: `Boolean!` --- **`email`**: `String` --- **`enforceMfa`**: `Boolean!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`ionBot`**: `Boolean!` --- **`isAdmin`**: `Boolean` --- **`lastLogin`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`name`**: `String` --- **`notificationEmailsEnabled`**: `Boolean!` --- **`organization`**: `Organization` --- **`organizationId`**: `Int!` --- **`permissionGroups`**: `[PermissionGroup]` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`teams`**: `[Team]` **Arguments:** - `filters`: `TeamsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserEventFilter` --- **`updatedBy`**: `[User]` --- **`updatedById`**: `Int` --- **`userRoles`**: `[UserRole]` **Arguments:** - `filters`: `UserRolesInputFilters` ## Examples ```graphql Query query User($id: ID!) { user(id: $id) { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "user": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } ``` # userDefinedMessage Source: https://docs.firstresonance.io/api-reference/queries/userDefinedMessage Retrieves an item by its ID. **query** `userDefinedMessage(id: ID!): UserDefinedMessage` ## Arguments **`id`**: `ID!` (required) ## Returns `UserDefinedMessage` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`message`**: `String!` --- **`messageKey`**: `UserDefinedMessageKey!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserDefinedMessageEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query UserDefinedMessage($id: ID!) { userDefinedMessage(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "userDefinedMessage": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # userDefinedMessages Source: https://docs.firstresonance.io/api-reference/queries/userDefinedMessages Retrieves a list of items. **query** `userDefinedMessages(after: String, before: String, distinctOn: [UserDefinedMessageSortEnum], filters: UserDefinedMessagesInputFilters, first: Int, last: Int, sort: [UserDefinedMessageSortEnum]): UserDefinedMessagesConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[UserDefinedMessageSortEnum]` --- **`filters`**: `UserDefinedMessagesInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[UserDefinedMessageSortEnum]` ## Returns `UserDefinedMessagesConnection` **`edges`**: `[UserDefinedMessagesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query UserDefinedMessages { userDefinedMessages { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "userDefinedMessages": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # userNotification Source: https://docs.firstresonance.io/api-reference/queries/userNotification Retrieves an item by its ID. **query** `userNotification(id: ID!): UserNotification` ## Arguments **`id`**: `ID!` (required) ## Returns `UserNotification` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`entityId`**: `Int` --- **`externalLink`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`linkText`**: `String` --- **`linkUrl`**: `String` --- **`path`**: `String` --- **`payload`**: `JSONString` --- **`prettyStr`**: `String` --- **`read`**: `Boolean!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserNotificationEventFilter` --- **`title`**: `String` --- **`type`**: `NotificationTypeEnum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`userId`**: `Int!` ## Examples ```graphql Query query UserNotification($id: ID!) { userNotification(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "userNotification": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # userNotifications Source: https://docs.firstresonance.io/api-reference/queries/userNotifications Retrieves a list of items. **query** `userNotifications(after: String, before: String, distinctOn: [UserNotificationSortEnum], filters: UserNotificationsInputFilters, first: Int, last: Int, sort: [UserNotificationSortEnum]): UserNotificationsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[UserNotificationSortEnum]` --- **`filters`**: `UserNotificationsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[UserNotificationSortEnum]` ## Returns `UserNotificationsConnection` **`edges`**: `[UserNotificationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query UserNotifications { userNotifications { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "userNotifications": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # userSubscription Source: https://docs.firstresonance.io/api-reference/queries/userSubscription Retrieves an item by its ID. **query** `userSubscription(id: ID!): UserSubscription` ## Arguments **`id`**: `ID!` (required) ## Returns `UserSubscription` **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserSubscriptionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`user`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`userId`**: `Int!` ## Examples ```graphql Query query UserSubscription($id: ID!) { userSubscription(id: $id) { LastSessionId _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "userSubscription": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 }, "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # userSubscriptions Source: https://docs.firstresonance.io/api-reference/queries/userSubscriptions Retrieves a list of items. **query** `userSubscriptions(after: String, before: String, distinctOn: [UserSubscriptionSortEnum], filters: UserSubscriptionsInputFilters, first: Int, last: Int, sort: [UserSubscriptionSortEnum]): UserSubscriptionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[UserSubscriptionSortEnum]` --- **`filters`**: `UserSubscriptionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[UserSubscriptionSortEnum]` ## Returns `UserSubscriptionsConnection` **`edges`**: `[UserSubscriptionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query UserSubscriptions { userSubscriptions { edges { cursor node { LastSessionId _created _etag _updated createdBy { __typename } createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "userSubscriptions": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" }, "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # users Source: https://docs.firstresonance.io/api-reference/queries/users Retrieves a list of items. **query** `users(after: String, before: String, distinctOn: [UserSortEnum], filters: UserInputFilters, first: Int, last: Int, sort: [UserSortEnum]): UsersConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[UserSortEnum]` --- **`filters`**: `UserInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[UserSortEnum]` ## Returns `UsersConnection` **`edges`**: `[UsersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query Users { users { edges { cursor node { LastSessionId Organization { __typename } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "users": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "Organization": { "__typename": "Organization" }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # validRunStepStatuses Source: https://docs.firstresonance.io/api-reference/queries/validRunStepStatuses Retrieves every run step status with whether it is currently valid and why. **query** `validRunStepStatuses(runStepId: ID!): [ValidRunStepStatus]` ## Arguments **`runStepId`**: `ID!` (required) ## Returns `[ValidRunStepStatus]` **`isValid`**: `Boolean!` --- **`reason`**: `String` --- **`status`**: `Statusenum!` ## Examples ```graphql Query query ValidRunStepStatuses($runStepId: ID!) { validRunStepStatuses(runStepId: $runStepId) { isValid reason status } } ``` ```json Variables { "runStepId": "id" } ``` ```json Response { "data": { "validRunStepStatuses": [ { "isValid": true, "reason": "string", "status": "CANCELED" } ] } } ``` # validRunStepStatusesReturnType Source: https://docs.firstresonance.io/api-reference/queries/validRunStepStatusesReturnType **query** `validRunStepStatusesReturnType: [ValidRunStepStatus]` ## Returns `[ValidRunStepStatus]` **`isValid`**: `Boolean!` --- **`reason`**: `String` --- **`status`**: `Statusenum!` ## Examples ```graphql Query query ValidRunStepStatusesReturnType { validRunStepStatusesReturnType { isValid reason status } } ``` ```json Response { "data": { "validRunStepStatusesReturnType": [ { "isValid": true, "reason": "string", "status": "CANCELED" } ] } } ``` # validateImportCsv Source: https://docs.firstresonance.io/api-reference/queries/validateImportCsv Validates an already-uploaded import CSV and returns all validation errors synchronously without committing, to gate createImportJob. **query** `validateImportCsv(fileKey: String!, type: ImportJobType!): ValidateImportCsvResult` ## Arguments **`fileKey`**: `String!` (required) --- **`type`**: `ImportJobType!` (required) ## Returns `ValidateImportCsvResult` **`durationSeconds`**: `Float` --- **`errors`**: `[ValidateImportCsvError]!` --- **`numRows`**: `Int` Number of rows validated (capped for large files). --- **`truncated`**: `Boolean` True if the file had more rows than were validated; the remainder is validated when the import is committed. --- **`valid`**: `Boolean!` ## Examples ```graphql Query query ValidateImportCsv($fileKey: String!, $type: ImportJobType!) { validateImportCsv(fileKey: $fileKey, type: $type) { durationSeconds errors { error row } numRows truncated valid } } ``` ```json Variables { "fileKey": "string", "type": "ABOM_INSTALLATIONS" } ``` ```json Response { "data": { "validateImportCsv": { "durationSeconds": 1.5, "errors": [ { "error": "string", "row": 1 } ], "numRows": 1, "truncated": true, "valid": true } } } ``` # validationFunction Source: https://docs.firstresonance.io/api-reference/queries/validationFunction Retrieves an item by its ID. **query** `validationFunction(id: ID!): ValidationFunction` ## Arguments **`id`**: `ID!` (required) ## Returns `ValidationFunction` **`_RunValidationsCount`**: `Int` Optimized count of runValidations. --- **`_ValidationsCount`**: `Int` Optimized count of validations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`displayName`**: `String` --- **`functionName`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`runValidations`**: `[RunStepFieldValidation]` **Arguments:** - `filters`: `RunStepFieldValidationsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ValidationFunctionEventFilter` --- **`validations`**: `[StepFieldValidation]` **Arguments:** - `filters`: `StepFieldValidationsInputFilters` ## Examples ```graphql Query query ValidationFunction($id: ID!) { validationFunction(id: $id) { _RunValidationsCount _ValidationsCount _created _etag _updated createdByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "validationFunction": { "_RunValidationsCount": 1, "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdByApiClient": { "id": 1, "name": "string" } } } } ``` # validationFunctions Source: https://docs.firstresonance.io/api-reference/queries/validationFunctions Retrieves a list of items. **query** `validationFunctions(after: String, before: String, distinctOn: [ValidationFunctionSortEnum], filters: ValidationFunctionsInputFilters, first: Int, last: Int, sort: [ValidationFunctionSortEnum]): ValidationFunctionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[ValidationFunctionSortEnum]` --- **`filters`**: `ValidationFunctionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[ValidationFunctionSortEnum]` ## Returns `ValidationFunctionsConnection` **`edges`**: `[ValidationFunctionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query ValidationFunctions { validationFunctions { edges { cursor node { _RunValidationsCount _ValidationsCount _created _etag _updated createdByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "validationFunctions": { "edges": [ { "cursor": "string", "node": { "_RunValidationsCount": 1, "_ValidationsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # webhookEvent Source: https://docs.firstresonance.io/api-reference/queries/webhookEvent Retrieves an item by its ID. **query** `webhookEvent(id: ID!): WebhookEvent` ## Arguments **`id`**: `ID!` (required) ## Returns `WebhookEvent` **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`numberOfRetries`**: `Int` --- **`prettyStr`**: `String` --- **`requestData`**: `String` --- **`responseData`**: `String` --- **`responseReceivedAt`**: `DateTime` --- **`responseStatusCode`**: `Int` --- **`status`**: `Webhookeventstatusenum!` --- **`subscription`**: `WebhookSubscription` **Arguments:** - `filters`: `WebhookSubscriptionsInputFilters` --- **`subscriptionId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookEventEventFilter` ## Examples ```graphql Query query WebhookEvent($id: ID!) { webhookEvent(id: $id) { _created _etag _updated createdByApiClient { id name } id lastUpdatedByApiClient { id name } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "webhookEvent": { "_created": "value", "_etag": "string", "_updated": "value", "createdByApiClient": { "id": 1, "name": "string" }, "id": 1, "lastUpdatedByApiClient": { "id": 1, "name": "string" } } } } ``` # webhookEvents Source: https://docs.firstresonance.io/api-reference/queries/webhookEvents Retrieves a list of items. **query** `webhookEvents(after: String, before: String, distinctOn: [WebhookEventSortEnum], filters: WebhookEventsInputFilters, first: Int, last: Int, sort: [WebhookEventSortEnum]): WebhookEventsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[WebhookEventSortEnum]` --- **`filters`**: `WebhookEventsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[WebhookEventSortEnum]` ## Returns `WebhookEventsConnection` **`edges`**: `[WebhookEventsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query WebhookEvents { webhookEvents { edges { cursor node { _created _etag _updated createdByApiClient { __typename } id lastUpdatedByApiClient { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "webhookEvents": { "edges": [ { "cursor": "string", "node": { "_created": "value", "_etag": "string", "_updated": "value", "createdByApiClient": { "__typename": "ApiClientAttribution" }, "id": 1, "lastUpdatedByApiClient": { "__typename": "ApiClientAttribution" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # webhookHeader Source: https://docs.firstresonance.io/api-reference/queries/webhookHeader Retrieves an item by its ID. **query** `webhookHeader(id: ID!): WebhookHeader` ## Arguments **`id`**: `ID!` (required) ## Returns `WebhookHeader` **`LastSessionId`**: `String` --- **`_WebhookReceiversCount`**: `Int` Optimized count of webhookReceivers. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`key`**: `String!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookHeaderEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String!` --- **`webhookReceivers`**: `[WebhookReceiver]` **Arguments:** - `filters`: `WebhookReceiversInputFilters` ## Examples ```graphql Query query WebhookHeader($id: ID!) { webhookHeader(id: $id) { LastSessionId _WebhookReceiversCount _created _etag _updated createdBy { LastSessionId Organization { LastSessionId _created _etag _updated aiAccessEnabled aiAccessEnabledForCurrentUser } _ActiveSessionsCount _AnalyticsCredentialCount _ApiKeysCount _PermissionGroupsCount } } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "webhookHeader": { "LastSessionId": "string", "_WebhookReceiversCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "LastSessionId": "string", "Organization": { "LastSessionId": "string", "_created": "value", "_etag": "string", "_updated": "value", "aiAccessEnabled": true, "aiAccessEnabledForCurrentUser": true }, "_ActiveSessionsCount": 1, "_AnalyticsCredentialCount": 1, "_ApiKeysCount": 1, "_PermissionGroupsCount": 1 } } } } ``` # webhookHeaders Source: https://docs.firstresonance.io/api-reference/queries/webhookHeaders Retrieves a list of items. **query** `webhookHeaders(after: String, before: String, distinctOn: [WebhookHeaderSortEnum], filters: WebhookHeadersInputFilters, first: Int, last: Int, sort: [WebhookHeaderSortEnum]): WebhookHeadersConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[WebhookHeaderSortEnum]` --- **`filters`**: `WebhookHeadersInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[WebhookHeaderSortEnum]` ## Returns `WebhookHeadersConnection` **`edges`**: `[WebhookHeadersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query WebhookHeaders { webhookHeaders { edges { cursor node { LastSessionId _WebhookReceiversCount _created _etag _updated createdBy { __typename } } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "webhookHeaders": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_WebhookReceiversCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "createdBy": { "__typename": "User" } } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # webhookReceiver Source: https://docs.firstresonance.io/api-reference/queries/webhookReceiver Retrieves an item by its ID. **query** `webhookReceiver(id: ID!): WebhookReceiver` ## Arguments **`id`**: `ID!` (required) ## Returns `WebhookReceiver` **`LastSessionId`**: `String` --- **`_HeadersCount`**: `Int` Optimized count of headers. --- **`_SubscriptionsCount`**: `Int` Optimized count of subscriptions. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`active`**: `Boolean` --- **`contentType`**: `Webhookcontenttypesenum` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`expectedResponseCode`**: `Int!` --- **`headers`**: `[WebhookHeader]` **Arguments:** - `filters`: `WebhookHeadersInputFilters` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`sharedSecret`**: `String!` --- **`subscriptions`**: `[WebhookSubscription]` **Arguments:** - `filters`: `WebhookSubscriptionsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookReceiverEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`webhookUri`**: `String!` ## Examples ```graphql Query query WebhookReceiver($id: ID!) { webhookReceiver(id: $id) { LastSessionId _HeadersCount _SubscriptionsCount _created _etag _updated } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "webhookReceiver": { "LastSessionId": "string", "_HeadersCount": 1, "_SubscriptionsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } } ``` # webhookReceivers Source: https://docs.firstresonance.io/api-reference/queries/webhookReceivers Retrieves a list of items. **query** `webhookReceivers(after: String, before: String, distinctOn: [WebhookReceiverSortEnum], filters: WebhookReceiversInputFilters, first: Int, last: Int, sort: [WebhookReceiverSortEnum]): WebhookReceiversConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[WebhookReceiverSortEnum]` --- **`filters`**: `WebhookReceiversInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[WebhookReceiverSortEnum]` ## Returns `WebhookReceiversConnection` **`edges`**: `[WebhookReceiversEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query WebhookReceivers { webhookReceivers { edges { cursor node { LastSessionId _HeadersCount _SubscriptionsCount _created _etag _updated } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "webhookReceivers": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_HeadersCount": 1, "_SubscriptionsCount": 1, "_created": "value", "_etag": "string", "_updated": "value" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # webhookSubscription Source: https://docs.firstresonance.io/api-reference/queries/webhookSubscription Retrieves an item by its ID. **query** `webhookSubscription(id: ID!): WebhookSubscription` ## Arguments **`id`**: `ID!` (required) ## Returns `WebhookSubscription` **`LastSessionId`**: `String` --- **`_EventsCount`**: `Int` Optimized count of events. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`action`**: `WebhookSubscriptionActions` --- **`active`**: `Boolean!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`events`**: `[WebhookEvent]` **Arguments:** - `filters`: `WebhookEventsInputFilters` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`receiver`**: `WebhookReceiver` **Arguments:** - `filters`: `WebhookReceiversInputFilters` --- **`receiverId`**: `Int` --- **`resource`**: `ResourceEnum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookSubscriptionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id ## Examples ```graphql Query query WebhookSubscription($id: ID!) { webhookSubscription(id: $id) { LastSessionId _EventsCount _created _etag _updated action } } ``` ```json Variables { "id": "id" } ``` ```json Response { "data": { "webhookSubscription": { "LastSessionId": "string", "_EventsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "action": "CREATE" } } } ``` # webhookSubscriptions Source: https://docs.firstresonance.io/api-reference/queries/webhookSubscriptions Retrieves a list of items. **query** `webhookSubscriptions(after: String, before: String, distinctOn: [WebhookSubscriptionSortEnum], filters: WebhookSubscriptionsInputFilters, first: Int, last: Int, sort: [WebhookSubscriptionSortEnum]): WebhookSubscriptionsConnection` ## Arguments **`after`**: `String` --- **`before`**: `String` --- **`distinctOn`**: `[WebhookSubscriptionSortEnum]` --- **`filters`**: `WebhookSubscriptionsInputFilters` --- **`first`**: `Int` --- **`last`**: `Int` --- **`sort`**: `[WebhookSubscriptionSortEnum]` ## Returns `WebhookSubscriptionsConnection` **`edges`**: `[WebhookSubscriptionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. ## Examples ```graphql Query query WebhookSubscriptions { webhookSubscriptions { edges { cursor node { LastSessionId _EventsCount _created _etag _updated action } } pageInfo { count endCursor hasNextPage hasPreviousPage startCursor totalCount } } } ``` ```json Response { "data": { "webhookSubscriptions": { "edges": [ { "cursor": "string", "node": { "LastSessionId": "string", "_EventsCount": 1, "_created": "value", "_etag": "string", "_updated": "value", "action": "CREATE" } } ], "pageInfo": { "count": 1, "endCursor": "string", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "string", "totalCount": 1 } } } } ``` # ABomInstallation Source: https://docs.firstresonance.io/api-reference/types/ABomInstallation An installation of a part on a build requirement. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` Return the build_requirement relationship. **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignator` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirementReferenceDesignatorId`**: `Int` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`partInventory`**: `PartInventory` Return the part_inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`quantityInstalledPerParentPartInventory`**: `Float!` Quantity installed per parent part inventory. --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepBuildRequirement`**: `RunStepBuildRequirement` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ABomInstallationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ABomInstallationEventFilter Source: https://docs.firstresonance.io/api-reference/types/ABomInstallationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`buildRequirementReferenceDesignatorId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partInventoryId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`quantityInstalledPerParentPartInventory`**: `FloatFilter` --- **`runStepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ABomInstallationEvents Source: https://docs.firstresonance.io/api-reference/types/ABomInstallationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ABomInstallation` --- **`oldValues`**: `ABomInstallation` --- **`timestamp`**: `DateTime` # ABomInstallationSortEnum Source: https://docs.firstresonance.io/api-reference/types/ABomInstallationSortEnum **Kind**: `enum` ## Values **`BUILD_REQUIREMENT_ID_ASC`** **`BUILD_REQUIREMENT_ID_DESC`** **`BUILD_REQUIREMENT_REFERENCE_DESIGNATOR_ID_ASC`** **`BUILD_REQUIREMENT_REFERENCE_DESIGNATOR_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`QUANTITY_INSTALLED_PER_PARENT_PART_INVENTORY_ASC`** **`QUANTITY_INSTALLED_PER_PARENT_PART_INVENTORY_DESC`** **`RUN_STEP_ID_ASC`** **`RUN_STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ABomInstallationsConnection Source: https://docs.firstresonance.io/api-reference/types/ABomInstallationsConnection **Kind**: `object` ## Fields **`edges`**: `[ABomInstallationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ABomInstallationsEdge Source: https://docs.firstresonance.io/api-reference/types/ABomInstallationsEdge A Relay edge containing a `ABomInstallations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ABomInstallation` The item at the end of the edge # ABomInstallationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ABomInstallationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ABomInstallationsInputFilters]` --- **`buildRequirement`**: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirementReferenceDesignatorId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ABomInstallationsInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`quantityInstalledPerParentPartInventory`**: `FloatFilter` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepBuildRequirement`**: `RunStepBuildRequirementsInputFilters` --- **`runStepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ABomSettings Source: https://docs.firstresonance.io/api-reference/types/ABomSettings Settings related to aBOMs. **Kind**: `object` ## Fields **`disableManualInstalls`**: `Boolean` --- **`roleBypasssesManualInstallsRestriction`**: `Int` # ABomSettingsInput Source: https://docs.firstresonance.io/api-reference/types/ABomSettingsInput Input settings related to aBOMs. **Kind**: `input` ## Fields **`disableManualInstalls`**: `Boolean` --- **`roleBypasssesManualInstallsRestriction`**: `Int` # APIKeyConnection Source: https://docs.firstresonance.io/api-reference/types/APIKeyConnection Connection for APIKeys. **Kind**: `object` ## Fields **`edges`**: `[APIKeyEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. # APIKeyEdge Source: https://docs.firstresonance.io/api-reference/types/APIKeyEdge A Relay edge containing a `APIKey` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `APIKeyObject` The item at the end of the edge # APIKeyInput Source: https://docs.firstresonance.io/api-reference/types/APIKeyInput APIKey input. **Kind**: `input` ## Fields **`_etag`**: `String!` (required) --- **`clientId`**: `String!` (required) --- **`description`**: `String` --- **`enabled`**: `Boolean` --- **`name`**: `String` --- **`regenerateSecret`**: `Boolean` # APIKeyInputFilters Source: https://docs.firstresonance.io/api-reference/types/APIKeyInputFilters Api Key filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`clientId`**: `StringFilter` --- **`createdById`**: `IntFilter` --- **`enabled`**: `BooleanFilter` --- **`id`**: `IntFilter` --- **`name`**: `StringFilter` --- **`updatedById`**: `IntFilter` # APIKeyObject Source: https://docs.firstresonance.io/api-reference/types/APIKeyObject APIKey return type. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`clientId`**: `String` --- **`clientSecret`**: `String` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` --- **`description`**: `String` --- **`enabled`**: `Boolean` --- **`id`**: `Int!` --- **`lastActive`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String` --- **`updatedById`**: `Int` --- **`user`**: `User` --- **`userId`**: `Int` # AcceptAiTermsOfService Source: https://docs.firstresonance.io/api-reference/types/AcceptAiTermsOfService Record this organization's acceptance of the AI Terms of Service. **Kind**: `object` ## Fields **`acceptance`**: `AiTosAcceptance` # AcceptStepProposal Source: https://docs.firstresonance.io/api-reference/types/AcceptStepProposal Writes a proposal's content onto its step and marks it accepted. **Kind**: `object` ## Fields **`step`**: `Step` --- **`stepProposal`**: `StepProposal` # ActivityParent Source: https://docs.firstresonance.io/api-reference/types/ActivityParent The record one level up that an activity row belongs to. **Kind**: `object` ## Fields **`id`**: `Int` --- **`label`**: `String` --- **`type`**: `String` # AddAssetToItem Source: https://docs.firstresonance.io/api-reference/types/AddAssetToItem Mutation to add an existing file attachment as an asset to an item. **Kind**: `object` ## Fields **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` # AddFileAttachmentToItem Source: https://docs.firstresonance.io/api-reference/types/AddFileAttachmentToItem Mutation to add an existing file attachment to an item via entities_file_attachments. **Kind**: `object` ## Fields **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` # AddHeaderToWebhookReceiver Source: https://docs.firstresonance.io/api-reference/types/AddHeaderToWebhookReceiver Mutation to add an header to webhook receiver. **Kind**: `object` ## Fields **`webhookReceiver`**: `WebhookReceiver` # AddInputToPlan Source: https://docs.firstresonance.io/api-reference/types/AddInputToPlan **Kind**: `object` ## Fields **`planInput`**: `PlanInput` # AddInputToPlanInput Source: https://docs.firstresonance.io/api-reference/types/AddInputToPlanInput **Kind**: `input` ## Fields **`Deleted`**: `Boolean` --- **`completedQuantity`**: `Int` --- **`dueDate`**: `DateTime!` (required) --- **`isGenerateNewDemand`**: `Boolean` --- **`isIndependent`**: `Boolean` --- **`name`**: `String` --- **`partId`**: `ID!` (required) --- **`planId`**: `ID!` (required) --- **`quantity`**: `Int!` (required) --- **`serialNumber`**: `String` # AddInventoriesToReceipt Source: https://docs.firstresonance.io/api-reference/types/AddInventoriesToReceipt Add multiple inventories to receipt. **Kind**: `object` ## Fields **`receipt`**: `Receipt` # AddInventoryToPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/AddInventoryToPurchaseOrderLine Mutation to add an inventory item to a purchase order line. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` # AddInventoryToReceipt Source: https://docs.firstresonance.io/api-reference/types/AddInventoryToReceipt Add a quantity of inventory to receipt. **Kind**: `object` ## Fields **`receipt`**: `Receipt` # AddInventoryToReceiptInput Source: https://docs.firstresonance.io/api-reference/types/AddInventoryToReceiptInput Input object for adding a quantity of inventory to receipt. **Kind**: `input` ## Fields **`autogenerateLotNumber`**: `Boolean` --- **`autogenerateSerialNumber`**: `Boolean` --- **`etag`**: `String!` (required) --- **`locationId`**: `Int` --- **`lotNumber`**: `String` --- **`partInventoryId`**: `Int!` (required) --- **`purchaseOrderLineId`**: `Int` --- **`quantity`**: `Float!` (required) --- **`receiptId`**: `Int!` (required) --- **`serialNumber`**: `String` # AddItemToReceiptInput Source: https://docs.firstresonance.io/api-reference/types/AddItemToReceiptInput Input object for adding a quantity of inventory to receipt. **Kind**: `input` ## Fields **`autogenerateLotNumber`**: `Boolean` --- **`autogenerateSerialNumber`**: `Boolean` --- **`etag`**: `String!` (required) --- **`locationId`**: `Int` --- **`lotNumber`**: `String` --- **`partInventoryId`**: `Int` --- **`purchaseOrderLineId`**: `Int` --- **`quantity`**: `Float!` (required) --- **`receiptId`**: `Int!` (required) --- **`serialNumber`**: `String` # AddItemsToReceipt Source: https://docs.firstresonance.io/api-reference/types/AddItemsToReceipt Add multiple items to receipt. **Kind**: `object` ## Fields **`receipt`**: `Receipt` # AddLabelToItem Source: https://docs.firstresonance.io/api-reference/types/AddLabelToItem Mutation to add a label to an item which has an entity. **Kind**: `object` ## Fields **`entityId`**: `Int` --- **`labelId`**: `Int` # AddLabelToProcedureFamily Source: https://docs.firstresonance.io/api-reference/types/AddLabelToProcedureFamily Relates a label to a procedure family given a LabelToProcedureFamilyInput item. **Kind**: `object` ## Fields **`familyId`**: `Int` --- **`labelId`**: `Int` # AddOAuthRedirectUri Source: https://docs.firstresonance.io/api-reference/types/AddOAuthRedirectUri Add a callback URL or allowed origin to an OAuth app. **Kind**: `object` ## Fields **`redirectUri`**: `OAuthRedirectUriObject` # AddPartInventoryToRunStep Source: https://docs.firstresonance.io/api-reference/types/AddPartInventoryToRunStep Attach a part inventory to a run step. **Kind**: `object` ## Fields **`runStep`**: `RunStep` # AddPartInventoryToRunStepInput Source: https://docs.firstresonance.io/api-reference/types/AddPartInventoryToRunStepInput Inputs needed attach a part inventory to a run step. **Kind**: `input` ## Fields **`etag`**: `String!` (required) Etag of the run step. --- **`partInventoryId`**: `ID!` (required) --- **`runStepId`**: `ID!` (required) # AddPartsToKitFromMbom Source: https://docs.firstresonance.io/api-reference/types/AddPartsToKitFromMbom Add parts to a kit from an mBOM. **Kind**: `object` ## Fields **`partKit`**: `PartKit` # AddPartsToKitFromMbomInput Source: https://docs.firstresonance.io/api-reference/types/AddPartsToKitFromMbomInput Inputs needed to add parts to a kit from an mBOM. **Kind**: `input` ## Fields **`etag`**: `String!` (required) Etag of the part kit. --- **`partId`**: `Int!` (required) --- **`partKitId`**: `Int!` (required) --- **`quantity`**: `Float` = 1 # AddPlanItemToPlan Source: https://docs.firstresonance.io/api-reference/types/AddPlanItemToPlan Add a plan item to a plan. **Kind**: `object` ## Fields **`plan`**: `Plan` # AddRequirementToItem Source: https://docs.firstresonance.io/api-reference/types/AddRequirementToItem Mutation to add a requirement to an item which has an entity. **Kind**: `object` ## Fields **`entityId`**: `Int` --- **`requirementId`**: `Int` # AddResultToPlanItem Source: https://docs.firstresonance.io/api-reference/types/AddResultToPlanItem Add a result to a plan item. **Kind**: `object` ## Fields **`planItem`**: `PlanItem` # AddSubtypeToPart Source: https://docs.firstresonance.io/api-reference/types/AddSubtypeToPart Add a part subtype to a part. **Kind**: `object` ## Fields **`part`**: `Part` # AddUserToTeam Source: https://docs.firstresonance.io/api-reference/types/AddUserToTeam Relates a User to a Team given a TeamToUserInput argument. **Kind**: `object` ## Fields **`teamId`**: `Int` --- **`userId`**: `Int` # AdminSettings Source: https://docs.firstresonance.io/api-reference/types/AdminSettings Settings related to admin allowable domains. **Kind**: `object` ## Fields **`allowedDomains`**: `[String]` --- **`attributes`**: `[AttributeSettings]` --- **`sidebarColor`**: `String` # AdminSettingsInput Source: https://docs.firstresonance.io/api-reference/types/AdminSettingsInput Settings related to admin allowable domains. **Kind**: `input` ## Fields **`allowedDomains`**: `[String]` --- **`sidebarColor`**: `String` # AggregatesField Source: https://docs.firstresonance.io/api-reference/types/AggregatesField Aggregates field for calling aggregate functions on graphql connection fields. **Kind**: `object` ## Fields **`count`**: `Int!` Count of current query. --- **`sum`**: `SumField!` # AiSettings Source: https://docs.firstresonance.io/api-reference/types/AiSettings Retained so clients built against the previous schema keep validating. Always resolves null; AI access is now `Organization.aiEnabled`. **Kind**: `object` ## Fields **`restrictToAdmins`**: `Boolean` > Deprecated: Superseded by Organization.aiEnabled. Always null. # AiSettingsInput Source: https://docs.firstresonance.io/api-reference/types/AiSettingsInput Accepted and discarded. Writes here change nothing; use `aiEnabled`. **Kind**: `input` ## Fields **`restrictToAdmins`**: `Boolean` # AiTermsOfService Source: https://docs.firstresonance.io/api-reference/types/AiTermsOfService The AI Terms of Service in force for this deployment's region. Served from the backend so the text an admin reads and the version recorded against their acceptance cannot drift apart. **Kind**: `object` ## Fields **`body`**: `String` The terms to display, as markdown. --- **`bodySha256`**: `String` Digest of the body served here. Submit it back with the acceptance to prove the text that was displayed is the text still in force. --- **`identifier`**: `String` The '-' value an acceptance must submit and that is recorded against it. --- **`variant`**: `String` Which terms govern this deployment: commercial or govcloud. Determined by the region, never by the caller. --- **`version`**: `String` This variant's version, bumped independently. # AiTosAcceptance Source: https://docs.firstresonance.io/api-reference/types/AiTosAcceptance An organization's record of accepting one version of the AI terms. Append-only: there is no mutation that edits or removes one of these. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`body`**: `String!` --- **`bodySha256`**: `String!` --- **`clientIpHash`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`identifier`**: `String` The '-' this acceptance covers. --- **`isCurrent`**: `Boolean` Whether this acceptance still satisfies the terms in force. False once the version is bumped, which re-gates AI until an admin accepts again. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`userAgent`**: `String` --- **`variant`**: `String!` --- **`version`**: `String!` # ApiClientActivity Source: https://docs.firstresonance.io/api-reference/types/ApiClientActivity A single audited action taken by an API client. **Kind**: `object` ## Fields **`actionType`**: `LoggedActionType` --- **`changeSummary`**: `JSONString` --- **`id`**: `ID!` --- **`label`**: `String` --- **`modelId`**: `Int` --- **`owningUserId`**: `Int` --- **`parent`**: `ActivityParent` --- **`tableName`**: `TableNameEnum` --- **`timestamp`**: `DateTime` --- **`transactionId`**: `ID` Audit transaction this action belongs to; rows sharing one are a single API call (the consumer groups by it). # ApiClientActivityConnection Source: https://docs.firstresonance.io/api-reference/types/ApiClientActivityConnection Relay connection of actions taken by a single API client. **Kind**: `object` ## Fields **`edges`**: `[ApiClientActivityEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ApiClientActivityEdge Source: https://docs.firstresonance.io/api-reference/types/ApiClientActivityEdge A Relay edge containing a `ApiClientActivity` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ApiClientActivity` The item at the end of the edge # ApiClientAttribution Source: https://docs.firstresonance.io/api-reference/types/ApiClientAttribution Minimal identity of an API client that made an audited change. Surfaced on every audited entity (via CommonFields) to distinguish a change made by an API client from one made directly by a human. **Kind**: `object` ## Fields **`id`**: `Int!` --- **`name`**: `String` # ApplyMbomChangeOrderLines Source: https://docs.firstresonance.io/api-reference/types/ApplyMbomChangeOrderLines Apply lines: execute resolutions, re-point each inventory's mBOM. One line or every line, always in one transaction: a line failing a guard rolls the whole batch back, so a click never leaves the change order half applied. **Kind**: `object` ## Fields **`mbomChanges`**: `[MbomChangeOrderLine]` # ApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevel The graphene sqlalchemy object type for approval levels. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_CandidateUsersCount`**: `Int` Optimized count of candidateUsers. --- **`_PurchaseOrderApprovalLevelsCount`**: `Int` Optimized count of purchaseOrderApprovalLevels. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`candidateUsers`**: `[User]` --- **`costThreshold`**: `Int!` Return the minimum purchase order cost that triggers this approval level. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`isDeleted`**: `Boolean!` --- **`isTeamSelectedLater`**: `Boolean!` Whether the team should be selected now or when the PO goes into review. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`ordinalPosition`**: `Int!` Return the order of this approval level in the chain. --- **`prettyStr`**: `String` --- **`purchaseOrderApprovalLevels`**: `[PurchaseOrderApprovalLevel]` --- **`role`**: `Role` Return role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return team foreign key. --- **`team`**: `Team` Return team relationship. **Arguments:** - `filters`: `TeamsInputFilters` --- **`teamId`**: `Int` Return team foreign key. --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ApprovalLevelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ApprovalLevelEventFilter Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevelEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`costThreshold`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isDeleted`**: `BooleanFilter` --- **`isTeamSelectedLater`**: `BooleanFilter` --- **`ordinalPosition`**: `IntFilter` --- **`roleId`**: `IDFilter` --- **`teamId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ApprovalLevelEvents Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevelEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ApprovalLevel` --- **`oldValues`**: `ApprovalLevel` --- **`timestamp`**: `DateTime` # ApprovalLevelInputFilters Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevelInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ApprovalLevelInputFilters]` --- **`candidateUsers`**: `UserInputFilters` --- **`costThreshold`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`isDeleted`**: `BooleanFilter` --- **`isTeamSelectedLater`**: `BooleanFilter` --- **`or_`**: `[ApprovalLevelInputFilters]` --- **`ordinalPosition`**: `IntFilter` --- **`purchaseOrderApprovalLevels`**: `PurchaseOrderApprovalLevelInputFilters` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`team`**: `TeamsInputFilters` --- **`teamId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ApprovalLevelSortEnum Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevelSortEnum **Kind**: `enum` ## Values **`COST_THRESHOLD_ASC`** **`COST_THRESHOLD_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_DELETED_ASC`** **`IS_DELETED_DESC`** **`IS_TEAM_SELECTED_LATER_ASC`** **`IS_TEAM_SELECTED_LATER_DESC`** **`ORDINAL_POSITION_ASC`** **`ORDINAL_POSITION_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`TEAM_ID_ASC`** **`TEAM_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ApprovalLevelsConnection Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevelsConnection **Kind**: `object` ## Fields **`edges`**: `[ApprovalLevelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ApprovalLevelsEdge Source: https://docs.firstresonance.io/api-reference/types/ApprovalLevelsEdge A Relay edge containing a `ApprovalLevels` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ApprovalLevel` The item at the end of the edge # ApprovalStatus Source: https://docs.firstresonance.io/api-reference/types/ApprovalStatus Enum for approval statuses. **Kind**: `enum` ## Values **`APPROVED`** **`PENDING`** **`REJECTED`** # Approvalstatusenum Source: https://docs.firstresonance.io/api-reference/types/Approvalstatusenum **Kind**: `enum` ## Values **`APPROVED`** **`PENDING`** **`REJECTED`** # ApprovalstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/ApprovalstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Approvalstatusenum` --- **`gt`**: `Approvalstatusenum` --- **`gte`**: `Approvalstatusenum` --- **`ilike`**: `Approvalstatusenum` --- **`in`**: `[Approvalstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Approvalstatusenum` --- **`lt`**: `Approvalstatusenum` --- **`lte`**: `Approvalstatusenum` --- **`neq`**: `Approvalstatusenum` --- **`notilike`**: `Approvalstatusenum` --- **`notlike`**: `Approvalstatusenum` # ArchiveRun Source: https://docs.firstresonance.io/api-reference/types/ArchiveRun Archives a Run given a ArchiveRunInput argument. **Kind**: `object` ## Fields **`run`**: `Run` # ArchiveRunInput Source: https://docs.firstresonance.io/api-reference/types/ArchiveRunInput Inputs needed to archive a Run. **Kind**: `input` ## Fields **`archived`**: `Boolean!` (required) --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) # AssetToItemInput Source: https://docs.firstresonance.io/api-reference/types/AssetToItemInput Inputs to attach an asset to an object through its entity id. **Kind**: `input` ## Fields **`entityId`**: `ID!` (required) --- **`fileAttachmentId`**: `ID!` (required) # AssignReferenceDesignatorToRunStep Source: https://docs.firstresonance.io/api-reference/types/AssignReferenceDesignatorToRunStep Assign a reference designator to a run step (redline-gated). **Kind**: `object` ## Fields **`runReferenceDesignatorAssignment`**: `RunReferenceDesignatorAssignment` # AssignReferenceDesignatorToRunStepInput Source: https://docs.firstresonance.io/api-reference/types/AssignReferenceDesignatorToRunStepInput Assign a reference designator to a run step. **Kind**: `input` ## Fields **`buildRequirementReferenceDesignatorId`**: `Int!` (required) --- **`runStepId`**: `Int!` (required) # AssignRunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/AssignRunStepBuildRequirement Assign (map) an existing aBOM build requirement to a run step. **Kind**: `object` ## Fields **`runStepBuildRequirement`**: `RunStepBuildRequirementMaterialized` # AssignRunStepBuildRequirementInput Source: https://docs.firstresonance.io/api-reference/types/AssignRunStepBuildRequirementInput Map an existing aBOM build requirement to a run step. **Kind**: `input` ## Fields **`buildRequirementId`**: `Int!` (required) --- **`quantity`**: `Float!` (required) --- **`runStepId`**: `Int!` (required) # AttachPermissionGroupToRole Source: https://docs.firstresonance.io/api-reference/types/AttachPermissionGroupToRole Attaches a PermissionGroup to a Role given a PermissionGroupToRoleInput argument. **Kind**: `object` ## Fields **`role`**: `Role` # AttachRoleToTeam Source: https://docs.firstresonance.io/api-reference/types/AttachRoleToTeam Attaches a Role to a Team given a TeamToRoleInput. **Kind**: `object` ## Fields **`roleId`**: `Int` --- **`teamId`**: `Int` # AttachRoleToUser Source: https://docs.firstresonance.io/api-reference/types/AttachRoleToUser Attaches a Role to a User given a RoleToUserInput argument. **Kind**: `object` ## Fields **`roleId`**: `Int` --- **`userId`**: `Int` # AttributeSettings Source: https://docs.firstresonance.io/api-reference/types/AttributeSettings Organization settings for extensible attributes. **Kind**: `object` ## Fields **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archived`**: `Boolean` --- **`archivedOptions`**: `[String]` --- **`criticality`**: `extensibleattributecriticalityenum` --- **`key`**: `String` --- **`options`**: `[String]` --- **`type`**: `attribute_typesattrtypesenum` # BarcodeLabel Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabel Barcode Label GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_BarcodePrintRequestsCount`**: `Int` Optimized count of barcodePrintRequests. --- **`_LocationCount`**: `Int` --- **`_PartInventoryCount`**: `Int` --- **`_PartKitCount`**: `Int` --- **`_RunCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcode`**: `String` --- **`barcodePrintRequests`**: `[BarcodePrintRequest]` **Arguments:** - `filters`: `BarcodePrintRequestsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deactivated`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`iuid`**: `String!` --- **`labelPreview`**: `FileAttachment` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`labelPreviewId`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`qrCode`**: `String` --- **`subject`**: `BarcodeSubject` --- **`template`**: `BarcodeTemplate` **Arguments:** - `filters`: `BarcodeTemplatesInputFilters` --- **`templateId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodeLabelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # BarcodeLabelEventFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabelEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`iuid`**: `StringFilter` --- **`labelPreviewId`**: `IDFilter` --- **`templateId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # BarcodeLabelEvents Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabelEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BarcodeLabel` --- **`oldValues`**: `BarcodeLabel` --- **`timestamp`**: `DateTime` # BarcodeLabelSortEnum Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabelSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`IUID_ASC`** **`IUID_DESC`** **`LABEL_PREVIEW_ID_ASC`** **`LABEL_PREVIEW_ID_DESC`** **`TEMPLATE_ID_ASC`** **`TEMPLATE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BarcodeLabelsConnection Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabelsConnection **Kind**: `object` ## Fields **`edges`**: `[BarcodeLabelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BarcodeLabelsEdge Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabelsEdge A Relay edge containing a `BarcodeLabels` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BarcodeLabel` The item at the end of the edge # BarcodeLabelsInputFilters Source: https://docs.firstresonance.io/api-reference/types/BarcodeLabelsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[BarcodeLabelsInputFilters]` --- **`barcodePrintRequests`**: `BarcodePrintRequestsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`iuid`**: `StringFilter` --- **`labelPreview`**: `FileAttachmentsInputFilters` --- **`labelPreviewId`**: `IDFilter` --- **`location`**: `LocationsInputFilters` --- **`or_`**: `[BarcodeLabelsInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partKit`**: `PartKitsInputFilters` --- **`run`**: `RunsInputFilters` --- **`template`**: `BarcodeTemplatesInputFilters` --- **`templateId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # BarcodePattern Source: https://docs.firstresonance.io/api-reference/types/BarcodePattern Barcode definition GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodePatternJson`**: `JSONString` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityType`**: `Barcodeentitytypeenum` --- **`expression`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodePatternEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # BarcodePatternEventFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodePatternEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`barcodePatternJson`**: `JSONStringFilter` --- **`createdById`**: `IDFilter` --- **`entityType`**: `BarcodeentitytypeenumFilter` --- **`eventType`**: `EventTypeFilter` --- **`expression`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`updatedById`**: `IDFilter` # BarcodePatternEvents Source: https://docs.firstresonance.io/api-reference/types/BarcodePatternEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BarcodePattern` --- **`oldValues`**: `BarcodePattern` --- **`timestamp`**: `DateTime` # BarcodePatternSortEnum Source: https://docs.firstresonance.io/api-reference/types/BarcodePatternSortEnum **Kind**: `enum` ## Values **`BARCODE_PATTERN_JSON_ASC`** **`BARCODE_PATTERN_JSON_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_TYPE_ASC`** **`ENTITY_TYPE_DESC`** **`EXPRESSION_ASC`** **`EXPRESSION_DESC`** **`ID_ASC`** **`ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BarcodePatternsConnection Source: https://docs.firstresonance.io/api-reference/types/BarcodePatternsConnection **Kind**: `object` ## Fields **`edges`**: `[BarcodePatternsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BarcodePatternsEdge Source: https://docs.firstresonance.io/api-reference/types/BarcodePatternsEdge A Relay edge containing a `BarcodePatterns` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BarcodePattern` The item at the end of the edge # BarcodePatternsInputFilters Source: https://docs.firstresonance.io/api-reference/types/BarcodePatternsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[BarcodePatternsInputFilters]` --- **`barcodePatternJson`**: `JSONStringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityType`**: `BarcodeentitytypeenumFilter` --- **`expression`**: `StringFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[BarcodePatternsInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # BarcodePrintRequest Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequest Barcode Print Request GQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodeLabel`**: `BarcodeLabel` **Arguments:** - `filters`: `BarcodeLabelsInputFilters` --- **`barcodeLabelId`**: `Int` --- **`barcodeType`**: `Barcodeentitytypeenum!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityData`**: `JSONString` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`printerId`**: `Int` --- **`quantity`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodePrintRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # BarcodePrintRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`barcodeLabelId`**: `IDFilter` --- **`barcodeType`**: `BarcodeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`entityData`**: `JSONStringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`printerId`**: `IntFilter` --- **`quantity`**: `IntFilter` --- **`updatedById`**: `IDFilter` # BarcodePrintRequestEvents Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BarcodePrintRequest` --- **`oldValues`**: `BarcodePrintRequest` --- **`timestamp`**: `DateTime` # BarcodePrintRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequestSortEnum **Kind**: `enum` ## Values **`BARCODE_LABEL_ID_ASC`** **`BARCODE_LABEL_ID_DESC`** **`BARCODE_TYPE_ASC`** **`BARCODE_TYPE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_DATA_ASC`** **`ENTITY_DATA_DESC`** **`ID_ASC`** **`ID_DESC`** **`PRINTER_ID_ASC`** **`PRINTER_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BarcodePrintRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[BarcodePrintRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BarcodePrintRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequestsEdge A Relay edge containing a `BarcodePrintRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BarcodePrintRequest` The item at the end of the edge # BarcodePrintRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/BarcodePrintRequestsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[BarcodePrintRequestsInputFilters]` --- **`barcodeLabel`**: `BarcodeLabelsInputFilters` --- **`barcodeLabelId`**: `IDFilter` --- **`barcodeType`**: `BarcodeentitytypeenumFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityData`**: `JSONStringFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[BarcodePrintRequestsInputFilters]` --- **`printerId`**: `IntFilter` --- **`quantity`**: `IntFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # BarcodeScanRequest Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequest Barcode Scan Request GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodeJson`**: `JSONString` --- **`barcodeText`**: `String` --- **`barcodeType`**: `Barcodeentitytypeenum` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityIds`**: `[Int]` --- **`id`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodeScanRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # BarcodeScanRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`barcodeJson`**: `JSONStringFilter` --- **`barcodeText`**: `StringFilter` --- **`barcodeType`**: `BarcodeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`entityIds`**: `IntFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`updatedById`**: `IDFilter` # BarcodeScanRequestEvents Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BarcodeScanRequest` --- **`oldValues`**: `BarcodeScanRequest` --- **`timestamp`**: `DateTime` # BarcodeScanRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequestSortEnum **Kind**: `enum` ## Values **`BARCODE_JSON_ASC`** **`BARCODE_JSON_DESC`** **`BARCODE_TEXT_ASC`** **`BARCODE_TEXT_DESC`** **`BARCODE_TYPE_ASC`** **`BARCODE_TYPE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_IDS_ASC`** **`ENTITY_IDS_DESC`** **`ID_ASC`** **`ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BarcodeScanRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[BarcodeScanRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BarcodeScanRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequestsEdge A Relay edge containing a `BarcodeScanRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BarcodeScanRequest` The item at the end of the edge # BarcodeScanRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/BarcodeScanRequestsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[BarcodeScanRequestsInputFilters]` --- **`barcodeJson`**: `JSONStringFilter` --- **`barcodeText`**: `StringFilter` --- **`barcodeType`**: `BarcodeentitytypeenumFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityIds`**: `IntFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[BarcodeScanRequestsInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # BarcodeSubject Source: https://docs.firstresonance.io/api-reference/types/BarcodeSubject Union of GraphQL objects that can be returned from barcode labels. **Kind**: `union` ## Possible types - `Location` - `PartInventory` - `PartKit` - `Run` # BarcodeTemplate Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplate Barcode Template GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_BarcodeLabelsCount`**: `Int` Optimized count of barcodeLabels. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`barcodeLabels`**: `[BarcodeLabel]` **Arguments:** - `filters`: `BarcodeLabelsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deactivated`**: `Boolean!` --- **`dpi`**: `Int!` --- **`entityType`**: `Barcodeentitytypeenum!` --- **`format`**: `Barcodeformatenum!` --- **`heightInches`**: `Float!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`template`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BarcodeTemplateEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`widthInches`**: `Float!` # BarcodeTemplateEventFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplateEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`deactivated`**: `BooleanFilter` --- **`dpi`**: `IntFilter` --- **`entityType`**: `BarcodeentitytypeenumFilter` --- **`eventType`**: `EventTypeFilter` --- **`format`**: `BarcodeformatenumFilter` --- **`heightInches`**: `FloatFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`template`**: `StringFilter` --- **`updatedById`**: `IDFilter` --- **`widthInches`**: `FloatFilter` # BarcodeTemplateEvents Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplateEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BarcodeTemplate` --- **`oldValues`**: `BarcodeTemplate` --- **`timestamp`**: `DateTime` # BarcodeTemplateFieldOptions Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplateFieldOptions Allowed field options for barcode templates by object type. **Kind**: `object` ## Fields **`options`**: `[String]` --- **`templateEntityType`**: `Barcodeentitytypeenum` # BarcodeTemplateSortEnum Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplateSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEACTIVATED_ASC`** **`DEACTIVATED_DESC`** **`DPI_ASC`** **`DPI_DESC`** **`ENTITY_TYPE_ASC`** **`ENTITY_TYPE_DESC`** **`FORMAT_ASC`** **`FORMAT_DESC`** **`HEIGHT_INCHES_ASC`** **`HEIGHT_INCHES_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`TEMPLATE_ASC`** **`TEMPLATE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`WIDTH_INCHES_ASC`** **`WIDTH_INCHES_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BarcodeTemplatesConnection Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplatesConnection **Kind**: `object` ## Fields **`edges`**: `[BarcodeTemplatesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BarcodeTemplatesEdge Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplatesEdge A Relay edge containing a `BarcodeTemplates` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BarcodeTemplate` The item at the end of the edge # BarcodeTemplatesInputFilters Source: https://docs.firstresonance.io/api-reference/types/BarcodeTemplatesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[BarcodeTemplatesInputFilters]` --- **`barcodeLabels`**: `BarcodeLabelsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`deactivated`**: `BooleanFilter` --- **`dpi`**: `IntFilter` --- **`entityType`**: `BarcodeentitytypeenumFilter` --- **`format`**: `BarcodeformatenumFilter` --- **`heightInches`**: `FloatFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[BarcodeTemplatesInputFilters]` --- **`template`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`widthInches`**: `FloatFilter` # Barcodeentitytypeenum Source: https://docs.firstresonance.io/api-reference/types/Barcodeentitytypeenum **Kind**: `enum` ## Values **`LOCATIONS`** **`PARTS_INVENTORY`** **`PARTS_KITS`** **`RUNS`** # BarcodeentitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodeentitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Barcodeentitytypeenum` --- **`gt`**: `Barcodeentitytypeenum` --- **`gte`**: `Barcodeentitytypeenum` --- **`ilike`**: `Barcodeentitytypeenum` --- **`in`**: `[Barcodeentitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Barcodeentitytypeenum` --- **`lt`**: `Barcodeentitytypeenum` --- **`lte`**: `Barcodeentitytypeenum` --- **`neq`**: `Barcodeentitytypeenum` --- **`notilike`**: `Barcodeentitytypeenum` --- **`notlike`**: `Barcodeentitytypeenum` # Barcodeformatenum Source: https://docs.firstresonance.io/api-reference/types/Barcodeformatenum **Kind**: `enum` ## Values **`ZPL`** # BarcodeformatenumFilter Source: https://docs.firstresonance.io/api-reference/types/BarcodeformatenumFilter **Kind**: `input` ## Fields **`eq`**: `Barcodeformatenum` --- **`gt`**: `Barcodeformatenum` --- **`gte`**: `Barcodeformatenum` --- **`ilike`**: `Barcodeformatenum` --- **`in`**: `[Barcodeformatenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Barcodeformatenum` --- **`lt`**: `Barcodeformatenum` --- **`lte`**: `Barcodeformatenum` --- **`neq`**: `Barcodeformatenum` --- **`notilike`**: `Barcodeformatenum` --- **`notlike`**: `Barcodeformatenum` # BatchRunSteps Source: https://docs.firstresonance.io/api-reference/types/BatchRunSteps Mutation to manually batch a group of run steps. **Kind**: `object` ## Fields **`runSteps`**: `[RunStep]` # BatchRunStepsInput Source: https://docs.firstresonance.io/api-reference/types/BatchRunStepsInput Inputs needed manually batch a group of run steps. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) # BooleanFilter Source: https://docs.firstresonance.io/api-reference/types/BooleanFilter **Kind**: `input` ## Fields **`eq`**: `Boolean` --- **`gt`**: `Boolean` --- **`gte`**: `Boolean` --- **`ilike`**: `Boolean` --- **`in`**: `[Boolean]` --- **`isnull`**: `Boolean` --- **`like`**: `Boolean` --- **`lt`**: `Boolean` --- **`lte`**: `Boolean` --- **`neq`**: `Boolean` --- **`notilike`**: `Boolean` --- **`notlike`**: `Boolean` # BuildRequirement Source: https://docs.firstresonance.io/api-reference/types/BuildRequirement A build requirement for an aBOM. Defines the requirements for the installation. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AcceptablePartsCount`**: `Int` Optimized count of acceptableParts. --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_BuildRequirementSubstitutesCount`**: `Int` Optimized count of buildRequirementSubstitutes. --- **`_InstalledPartInventoriesCount`**: `Int` Optimized count of installedPartInventories. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_RunStepBuildRequirementsCount`**: `Int` Optimized count of runStepBuildRequirements. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `Int!` --- **`acceptablePartIds`**: `[Int]` Acceptable parts for this build requirement. --- **`acceptableParts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirementSubstitutes`**: `[BuildRequirementSubstitute]` **Arguments:** - `filters`: `BuildRequirementSubstitutesInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`fixedQuantityPerBuildRequirement`**: `Float` > Deprecated: Deprecated. Use quantityPerParentPartInventory instead. --- **`id`**: `Int!` --- **`installedPartInventories`**: `[PartInventory]` Part inventories installed on this build requirement. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`madeOnAssembly`**: `Boolean!` --- **`originMbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`originMbomItemId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`percentInstalled`**: `Int` Percent of the build requirement that is installed. Does not exceed 100% even when parts are over-installed. --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`quantityPerParentPartInventory`**: `Float!` This quantity multiplied by the parent part inventory's quantity is used in the calculation of the BuildRequirement's quantity. --- **`runStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BuildRequirementEventFilter` --- **`totalInstalledQuantity`**: `Float` --- **`totalParentPartInventoriesQuantity`**: `Float` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # BuildRequirementEventFilter Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`abomInstallationsCount`**: `IntFilter` --- **`acceptablePartIds`**: `IntFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`madeOnAssembly`**: `BooleanFilter` --- **`originMbomItemId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`percentInstalled`**: `IntFilter` --- **`quantity`**: `FloatFilter` --- **`quantityPerParentPartInventory`**: `FloatFilter` --- **`totalInstalledQuantity`**: `FloatFilter` --- **`totalParentPartInventoriesQuantity`**: `FloatFilter` --- **`updatedById`**: `IDFilter` # BuildRequirementEvents Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BuildRequirement` --- **`oldValues`**: `BuildRequirement` --- **`timestamp`**: `DateTime` # BuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignator A reference designator for a build requirement. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_InstalledPartInventoriesCount`**: `Int` Optimized count of installedPartInventories. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`assignedQuantity`**: `Int` The number of times this reference designator should be installed. A reference designator may be installed one time per qty of a multi-quantity producing RUN (e.g. for a run building 10 qty of part X), a reference designator may be installed 10 times). --- **`assignedRunStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`installedPartInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`installedQuantity`**: `Int` The number of times this reference designator has been installed. A reference designator may be installed one time per qty of a multi-quantity producing RUN (e.g. for a run building 10 qty of part X), a reference designator may be installed 10 times). --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`originMbomItemReferenceDesignator`**: `MBomItemReferenceDesignator` **Arguments:** - `filters`: `MBomItemReferenceDesignatorsInputFilters` --- **`originMbomItemReferenceDesignatorId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String!` # BuildRequirementReferenceDesignatorEventFilter Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignatorEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedQuantity`**: `IntFilter` --- **`buildRequirementId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`installedQuantity`**: `IntFilter` --- **`originMbomItemReferenceDesignatorId`**: `IDFilter` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # BuildRequirementReferenceDesignatorEvents Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignatorEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BuildRequirementReferenceDesignator` --- **`oldValues`**: `BuildRequirementReferenceDesignator` --- **`timestamp`**: `DateTime` # BuildRequirementReferenceDesignatorSortEnum Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignatorSortEnum **Kind**: `enum` ## Values **`ASSIGNED_QUANTITY_ASC`** **`ASSIGNED_QUANTITY_DESC`** **`BUILD_REQUIREMENT_ID_ASC`** **`BUILD_REQUIREMENT_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`INSTALLED_QUANTITY_ASC`** **`INSTALLED_QUANTITY_DESC`** **`ORIGIN_MBOM_ITEM_REFERENCE_DESIGNATOR_ID_ASC`** **`ORIGIN_MBOM_ITEM_REFERENCE_DESIGNATOR_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BuildRequirementReferenceDesignatorsConnection Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignatorsConnection **Kind**: `object` ## Fields **`edges`**: `[BuildRequirementReferenceDesignatorsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BuildRequirementReferenceDesignatorsEdge Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignatorsEdge A Relay edge containing a `BuildRequirementReferenceDesignators` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BuildRequirementReferenceDesignator` The item at the end of the edge # BuildRequirementReferenceDesignatorsInputFilters Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementReferenceDesignatorsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`abomInstallations`**: `ABomInstallationsInputFilters` --- **`and_`**: `[BuildRequirementReferenceDesignatorsInputFilters]` --- **`assignedQuantity`**: `IntFilter` --- **`assignedRunStepBuildRequirements`**: `RunStepBuildRequirementsInputFilters` --- **`buildRequirement`**: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`installedPartInventories`**: `PartInventoriesInputFilters` --- **`installedQuantity`**: `IntFilter` --- **`or_`**: `[BuildRequirementReferenceDesignatorsInputFilters]` --- **`originMbomItemReferenceDesignator`**: `MBomItemReferenceDesignatorsInputFilters` --- **`originMbomItemReferenceDesignatorId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # BuildRequirementSortEnum Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSortEnum **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS_COUNT_ASC`** **`ABOM_INSTALLATIONS_COUNT_DESC`** **`ACCEPTABLE_PART_IDS_ASC`** **`ACCEPTABLE_PART_IDS_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`MADE_ON_ASSEMBLY_ASC`** **`MADE_ON_ASSEMBLY_DESC`** **`ORIGIN_MBOM_ITEM_ID_ASC`** **`ORIGIN_MBOM_ITEM_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PERCENT_INSTALLED_ASC`** **`PERCENT_INSTALLED_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`QUANTITY_PER_PARENT_PART_INVENTORY_ASC`** **`QUANTITY_PER_PARENT_PART_INVENTORY_DESC`** **`TOTAL_INSTALLED_QUANTITY_ASC`** **`TOTAL_INSTALLED_QUANTITY_DESC`** **`TOTAL_PARENT_PART_INVENTORIES_QUANTITY_ASC`** **`TOTAL_PARENT_PART_INVENTORIES_QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstitute A substitute for a build requirement. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`originMbomSubstitute`**: `MBomSubstitute` **Arguments:** - `filters`: `MBomSubstituteInputFilters` --- **`originMbomSubstituteId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `BuildRequirementSubstituteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # BuildRequirementSubstituteEventFilter Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstituteEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`originMbomSubstituteId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # BuildRequirementSubstituteEvents Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstituteEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `BuildRequirementSubstitute` --- **`oldValues`**: `BuildRequirementSubstitute` --- **`timestamp`**: `DateTime` # BuildRequirementSubstituteSortEnum Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstituteSortEnum **Kind**: `enum` ## Values **`BUILD_REQUIREMENT_ID_ASC`** **`BUILD_REQUIREMENT_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`ORIGIN_MBOM_SUBSTITUTE_ID_ASC`** **`ORIGIN_MBOM_SUBSTITUTE_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # BuildRequirementSubstitutesConnection Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstitutesConnection **Kind**: `object` ## Fields **`edges`**: `[BuildRequirementSubstitutesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BuildRequirementSubstitutesEdge Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstitutesEdge A Relay edge containing a `BuildRequirementSubstitutes` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BuildRequirementSubstitute` The item at the end of the edge # BuildRequirementSubstitutesInputFilters Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementSubstitutesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[BuildRequirementSubstitutesInputFilters]` --- **`buildRequirement`**: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[BuildRequirementSubstitutesInputFilters]` --- **`originMbomSubstitute`**: `MBomSubstituteInputFilters` --- **`originMbomSubstituteId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # BuildRequirementsConnection Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementsConnection **Kind**: `object` ## Fields **`edges`**: `[BuildRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # BuildRequirementsEdge Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementsEdge A Relay edge containing a `BuildRequirements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `BuildRequirement` The item at the end of the edge # BuildRequirementsInputFilters Source: https://docs.firstresonance.io/api-reference/types/BuildRequirementsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`abomInstallations`**: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `IntFilter` --- **`acceptablePartIds`**: `IntFilter` --- **`acceptableParts`**: `PartsInputFilters` --- **`and_`**: `[BuildRequirementsInputFilters]` --- **`buildRequirementReferenceDesignators`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirementSubstitutes`**: `BuildRequirementSubstitutesInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`madeOnAssembly`**: `BooleanFilter` --- **`or_`**: `[BuildRequirementsInputFilters]` --- **`originMbomItem`**: `MBomItemsInputFilters` --- **`originMbomItemId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`percentInstalled`**: `IntFilter` --- **`quantity`**: `FloatFilter` --- **`quantityPerParentPartInventory`**: `FloatFilter` --- **`runStepBuildRequirements`**: `RunStepBuildRequirementsInputFilters` --- **`totalInstalledQuantity`**: `FloatFilter` --- **`totalParentPartInventoriesQuantity`**: `FloatFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # CancelChangeOrder Source: https://docs.firstresonance.io/api-reference/types/CancelChangeOrder Cancel a change order. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # CancelPickRun Source: https://docs.firstresonance.io/api-reference/types/CancelPickRun Abandon a run and release the stock it still holds. **Kind**: `object` ## Fields **`pickRun`**: `PickRun` # CancelPickRunInput Source: https://docs.firstresonance.io/api-reference/types/CancelPickRunInput Which run to cancel. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`pickRunId`**: `ID!` (required) # CancelRun Source: https://docs.firstresonance.io/api-reference/types/CancelRun Cancels a Run given a CancelRunInput argument. **Kind**: `object` ## Fields **`run`**: `Run` # CancelRunInput Source: https://docs.firstresonance.io/api-reference/types/CancelRunInput Inputs needed to cancel a Run. **Kind**: `input` ## Fields **`disposition`**: `RunCancellationDisposition` What happens to the run's output inventory. Defaults to DEFER (send to the review queue) when omitted. --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) # CancelRunStepRedline Source: https://docs.firstresonance.io/api-reference/types/CancelRunStepRedline Cancels RunStep redlining given an id. **Kind**: `object` ## Fields **`runStep`**: `RunStep` # ChangeOrder Source: https://docs.firstresonance.io/api-reference/types/ChangeOrder A change order (ECO): governs adoption of a released version. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[ChangeOrderApprovalRequest]` **Arguments:** - `filters`: `ChangeOrderApprovalRequestsInputFilters` --- **`approvals`**: `[ChangeOrderApproval]` **Arguments:** - `filters`: `ChangeOrderApprovalsInputFilters` --- **`approvedAt`**: `DateTime` --- **`changeOrderType`**: `Changeordertypeenum!` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `Int!` --- **`labels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`lineCount`**: `Int` --- **`prettyStr`**: `String` --- **`status`**: `Changeorderstatusenum!` --- **`targetEntity`**: `Entity` **Arguments:** - `filters`: `EntitysInputFilters` --- **`targetEntityId`**: `Float!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ChangeOrderApproval Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApproval An approval related to a change order. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`changeOrder`**: `ChangeOrder` **Arguments:** - `filters`: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `Int!` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Changeorderapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `ChangeOrderApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[ChangeOrderApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ChangeOrderApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`changeOrderId`**: `IDFilter` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `ChangeorderapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # ChangeOrderApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ChangeOrderApproval` --- **`oldValues`**: `ChangeOrderApproval` --- **`timestamp`**: `DateTime` # ChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequest A request to approve a change order. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`changeOrder`**: `ChangeOrder` **Arguments:** - `filters`: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Changeorderapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ChangeOrderApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`changeOrderId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `ChangeorderapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # ChangeOrderApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ChangeOrderApprovalRequest` --- **`oldValues`**: `ChangeOrderApprovalRequest` --- **`timestamp`**: `DateTime` # ChangeOrderApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CHANGE_ORDER_ID_ASC`** **`CHANGE_ORDER_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ChangeOrderApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[ChangeOrderApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ChangeOrderApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequestsEdge A Relay edge containing a `ChangeOrderApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ChangeOrderApprovalRequest` The item at the end of the edge # ChangeOrderApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRequestsInputFilters ChangeOrderApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ChangeOrderApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`changeOrder`**: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `ChangeorderapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ChangeOrderApprovalRequestsInputFilters]` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRole Approval role type for change orders. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`gateType`**: `Changeorderapprovalgatetypeenum!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ChangeOrderApprovalRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ChangeOrderApprovalRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `ChangeorderapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ChangeOrderApprovalRoleEvents Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ChangeOrderApprovalRole` --- **`oldValues`**: `ChangeOrderApprovalRole` --- **`timestamp`**: `DateTime` # ChangeOrderApprovalRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ChangeOrderApprovalRolesConnection Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRolesConnection **Kind**: `object` ## Fields **`edges`**: `[ChangeOrderApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ChangeOrderApprovalRolesEdge Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRolesEdge A Relay edge containing a `ChangeOrderApprovalRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ChangeOrderApprovalRole` The item at the end of the edge # ChangeOrderApprovalRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalRolesInputFilters ChangeOrderApprovalRole filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ChangeOrderApprovalRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`gateType`**: `ChangeorderapprovalgatetypeenumFilter` --- **`or_`**: `[ChangeOrderApprovalRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ChangeOrderApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalSortEnum **Kind**: `enum` ## Values **`CHANGE_ORDER_ID_ASC`** **`CHANGE_ORDER_ID_DESC`** **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ChangeOrderApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[ChangeOrderApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ChangeOrderApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalsEdge A Relay edge containing a `ChangeOrderApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ChangeOrderApproval` The item at the end of the edge # ChangeOrderApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderApprovalsInputFilters ChangeOrderApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ChangeOrderApprovalsInputFilters]` --- **`changeOrder`**: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `IDFilter` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `ChangeorderapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ChangeOrderApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ChangeOrderEventFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`approvedAt`**: `DateTimeFilter` --- **`changeOrderType`**: `ChangeordertypeenumFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`status`**: `ChangeorderstatusenumFilter` --- **`targetEntityId`**: `FloatFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # ChangeOrderEvents Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ChangeOrder` --- **`oldValues`**: `ChangeOrder` --- **`timestamp`**: `DateTime` # ChangeOrderLineStatus Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderLineStatus A line's state on a change order. Derived from its stamps, never stored. The stamps and their ``_by_id`` partners already answer who and when, so a stored column would be a second copy of the same fact. **Kind**: `enum` ## Values **`APPLIED`** **`CANCELED`** **`PENDING`** # ChangeOrderLineStatusFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderLineStatusFilter **Kind**: `input` ## Fields **`eq`**: `ChangeOrderLineStatus` --- **`gt`**: `ChangeOrderLineStatus` --- **`gte`**: `ChangeOrderLineStatus` --- **`ilike`**: `ChangeOrderLineStatus` --- **`in`**: `[ChangeOrderLineStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `ChangeOrderLineStatus` --- **`lt`**: `ChangeOrderLineStatus` --- **`lte`**: `ChangeOrderLineStatus` --- **`neq`**: `ChangeOrderLineStatus` --- **`notilike`**: `ChangeOrderLineStatus` --- **`notlike`**: `ChangeOrderLineStatus` # ChangeOrderSortEnum Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderSortEnum **Kind**: `enum` ## Values **`APPROVED_AT_ASC`** **`APPROVED_AT_DESC`** **`CHANGE_ORDER_TYPE_ASC`** **`CHANGE_ORDER_TYPE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TARGET_ENTITY_ID_ASC`** **`TARGET_ENTITY_ID_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ChangeOrderStatusTransitionInput Source: https://docs.firstresonance.io/api-reference/types/ChangeOrderStatusTransitionInput Identifies a change order to move, with its etag. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) # ChangeOrdersConnection Source: https://docs.firstresonance.io/api-reference/types/ChangeOrdersConnection **Kind**: `object` ## Fields **`edges`**: `[ChangeOrdersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ChangeOrdersEdge Source: https://docs.firstresonance.io/api-reference/types/ChangeOrdersEdge A Relay edge containing a `ChangeOrders` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ChangeOrder` The item at the end of the edge # ChangeOrdersInputFilters Source: https://docs.firstresonance.io/api-reference/types/ChangeOrdersInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ChangeOrdersInputFilters]` --- **`approvalRequests`**: `ChangeOrderApprovalRequestsInputFilters` --- **`approvals`**: `ChangeOrderApprovalsInputFilters` --- **`approvedAt`**: `DateTimeFilter` --- **`changeOrderType`**: `ChangeordertypeenumFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`labels`**: `LabelsInputFilters` --- **`or_`**: `[ChangeOrdersInputFilters]` --- **`status`**: `ChangeorderstatusenumFilter` --- **`targetEntity`**: `EntitysInputFilters` --- **`targetEntityId`**: `FloatFilter` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ChangedAttributes Source: https://docs.firstresonance.io/api-reference/types/ChangedAttributes Graphql object to track changed columns in a Timeline Event. **Kind**: `object` ## Fields **`field`**: `String` --- **`newValue`**: `ScalarValue` --- **`oldValue`**: `ScalarValue` # Changeorderapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Changeorderapprovalgatetypeenum **Kind**: `enum` ## Values **`APPROVED`** # ChangeorderapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeorderapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Changeorderapprovalgatetypeenum` --- **`gt`**: `Changeorderapprovalgatetypeenum` --- **`gte`**: `Changeorderapprovalgatetypeenum` --- **`ilike`**: `Changeorderapprovalgatetypeenum` --- **`in`**: `[Changeorderapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Changeorderapprovalgatetypeenum` --- **`lt`**: `Changeorderapprovalgatetypeenum` --- **`lte`**: `Changeorderapprovalgatetypeenum` --- **`neq`**: `Changeorderapprovalgatetypeenum` --- **`notilike`**: `Changeorderapprovalgatetypeenum` --- **`notlike`**: `Changeorderapprovalgatetypeenum` # Changeorderstatusenum Source: https://docs.firstresonance.io/api-reference/types/Changeorderstatusenum **Kind**: `enum` ## Values **`APPROVED`** **`CANCELED`** **`COMPLETED`** **`DRAFT`** **`UNDER_REVIEW`** # ChangeorderstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeorderstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Changeorderstatusenum` --- **`gt`**: `Changeorderstatusenum` --- **`gte`**: `Changeorderstatusenum` --- **`ilike`**: `Changeorderstatusenum` --- **`in`**: `[Changeorderstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Changeorderstatusenum` --- **`lt`**: `Changeorderstatusenum` --- **`lte`**: `Changeorderstatusenum` --- **`neq`**: `Changeorderstatusenum` --- **`notilike`**: `Changeorderstatusenum` --- **`notlike`**: `Changeorderstatusenum` # Changeordertypeenum Source: https://docs.firstresonance.io/api-reference/types/Changeordertypeenum **Kind**: `enum` ## Values **`MBOM_CHANGE`** # ChangeordertypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/ChangeordertypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Changeordertypeenum` --- **`gt`**: `Changeordertypeenum` --- **`gte`**: `Changeordertypeenum` --- **`ilike`**: `Changeordertypeenum` --- **`in`**: `[Changeordertypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Changeordertypeenum` --- **`lt`**: `Changeordertypeenum` --- **`lte`**: `Changeordertypeenum` --- **`neq`**: `Changeordertypeenum` --- **`notilike`**: `Changeordertypeenum` --- **`notlike`**: `Changeordertypeenum` # ChargeAccount Source: https://docs.firstresonance.io/api-reference/types/ChargeAccount The graphene sqlalchemy object type for charge account. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`archived`**: `Boolean!` --- **`code`**: `String!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ChargeAccountSortEnum Source: https://docs.firstresonance.io/api-reference/types/ChargeAccountSortEnum **Kind**: `enum` ## Values **`ARCHIVED_ASC`** **`ARCHIVED_DESC`** **`CODE_ASC`** **`CODE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ChargeAccountsConnection Source: https://docs.firstresonance.io/api-reference/types/ChargeAccountsConnection **Kind**: `object` ## Fields **`edges`**: `[ChargeAccountsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ChargeAccountsEdge Source: https://docs.firstresonance.io/api-reference/types/ChargeAccountsEdge A Relay edge containing a `ChargeAccounts` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ChargeAccount` The item at the end of the edge # ChargeAccountsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ChargeAccountsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ChargeAccountsInputFilters]` --- **`archived`**: `BooleanFilter` --- **`code`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ChargeAccountsInputFilters]` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # CheckIn Source: https://docs.firstresonance.io/api-reference/types/CheckIn Create session event of type check in. **Kind**: `object` ## Fields **`checkInEvent`**: `SessionEvent` # CheckOut Source: https://docs.firstresonance.io/api-reference/types/CheckOut Create session event of type check out. **Kind**: `object` ## Fields **`checkOutEvent`**: `SessionEvent` # CheckSSOConnectionStatus Source: https://docs.firstresonance.io/api-reference/types/CheckSSOConnectionStatus Check whether the customer has completed SSO setup. **Kind**: `object` ## Fields **`status`**: `SSOConnectionStatus` # ClearStepProposal Source: https://docs.firstresonance.io/api-reference/types/ClearStepProposal Removes one settled proposal from the list without changing how it ended. **Kind**: `object` ## Fields **`stepProposal`**: `StepProposal` # ClearStepProposals Source: https://docs.firstresonance.io/api-reference/types/ClearStepProposals Removes every settled proposal on a procedure from the list. **Kind**: `object` ## Fields **`clearedCount`**: `Int` # CloneProcedure Source: https://docs.firstresonance.io/api-reference/types/CloneProcedure Clones a Procedure given it's Id. **Kind**: `object` ## Fields **`procedure`**: `Procedure` # Comment Source: https://docs.firstresonance.io/api-reference/types/Comment A comment related to Runs and RunSteps. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_RunCount`**: `Int` --- **`_RunStepCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[Comment]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchAdoptedSiblings`**: `[Comment]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[Comment]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `Boolean` --- **`content`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `Comment` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`procedureFeedback`**: `Boolean!` --- **`replies`**: `[Comment]` --- **`resolved`**: `Boolean!` --- **`run`**: `Run` --- **`runStep`**: `RunStep` --- **`slateContent`**: `SlateContent` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `CommentEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # CommentEventFilter Source: https://docs.firstresonance.io/api-reference/types/CommentEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`content`**: `StringFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`procedureFeedback`**: `BooleanFilter` --- **`resolved`**: `BooleanFilter` --- **`slateContent`**: `SlateContentFilter` --- **`updatedById`**: `IDFilter` # CommentEvents Source: https://docs.firstresonance.io/api-reference/types/CommentEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Comment` --- **`oldValues`**: `Comment` --- **`timestamp`**: `DateTime` # CommentSortEnum Source: https://docs.firstresonance.io/api-reference/types/CommentSortEnum **Kind**: `enum` ## Values **`CONTENT_ASC`** **`CONTENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PROCEDURE_FEEDBACK_ASC`** **`PROCEDURE_FEEDBACK_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # CommentsConnection Source: https://docs.firstresonance.io/api-reference/types/CommentsConnection **Kind**: `object` ## Fields **`edges`**: `[CommentsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # CommentsEdge Source: https://docs.firstresonance.io/api-reference/types/CommentsEdge A Relay edge containing a `Comments` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Comment` The item at the end of the edge # CommentsInputFilters Source: https://docs.firstresonance.io/api-reference/types/CommentsInputFilters Filters related to Comments. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[CommentsInputFilters]` --- **`batched`**: `BooleanFilter` --- **`content`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[CommentsInputFilters]` --- **`parentId`**: `IDFilter` --- **`procedureFeedback`**: `BooleanFilter` --- **`resolved`**: `BooleanFilter` --- **`run`**: `RunsInputFilters` --- **`runStep`**: `RunStepsInputFilters` --- **`slateContent`**: `SlateContentNullFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # CompleteChangeOrder Source: https://docs.firstresonance.io/api-reference/types/CompleteChangeOrder Close a change order whose lines have all closed. A workflow closes one on its own as the last line closes, so this is the manual route for a change order that stopped short of that. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # ConfirmMbomChangeOrderLineDiffResolution Source: https://docs.firstresonance.io/api-reference/types/ConfirmMbomChangeOrderLineDiffResolution Confirm diff resolutions: one row or many, one line or every line. **Kind**: `object` ## Fields **`diffs`**: `[MbomChangeOrderLineDiff]` # ConfirmMbomChangeOrderLineDiffResolutionInput Source: https://docs.firstresonance.io/api-reference/types/ConfirmMbomChangeOrderLineDiffResolutionInput Input to confirm the resolution of one or many diffs. **Kind**: `input` ## Fields **`confirmMatchingDiffs`**: `Boolean` --- **`sources`**: `[ConfirmMbomChangeOrderLineDiffSourceInput]!` (required) # ConfirmMbomChangeOrderLineDiffSourceInput Source: https://docs.firstresonance.io/api-reference/types/ConfirmMbomChangeOrderLineDiffSourceInput One diff the caller is confirming, with the resolution to confirm. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`resolutionType`**: `MbomChangeResolution!` (required) # ConstraintOperator Source: https://docs.firstresonance.io/api-reference/types/ConstraintOperator Enum of plan constraint operators. **Kind**: `enum` ## Values **`IN`** **`NOT_IN`** # Constraintoperatorenum Source: https://docs.firstresonance.io/api-reference/types/Constraintoperatorenum **Kind**: `enum` ## Values **`IN`** **`NOT_IN`** # ConstraintoperatorenumFilter Source: https://docs.firstresonance.io/api-reference/types/ConstraintoperatorenumFilter **Kind**: `input` ## Fields **`eq`**: `Constraintoperatorenum` --- **`gt`**: `Constraintoperatorenum` --- **`gte`**: `Constraintoperatorenum` --- **`ilike`**: `Constraintoperatorenum` --- **`in`**: `[Constraintoperatorenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Constraintoperatorenum` --- **`lt`**: `Constraintoperatorenum` --- **`lte`**: `Constraintoperatorenum` --- **`neq`**: `Constraintoperatorenum` --- **`notilike`**: `Constraintoperatorenum` --- **`notlike`**: `Constraintoperatorenum` # Contact Source: https://docs.firstresonance.io/api-reference/types/Contact Contact GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`email`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` **Arguments:** - `filters`: `LocationsInputFilters` --- **`name`**: `String!` --- **`phoneNumber`**: `String` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ContactEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ContactEventFilter Source: https://docs.firstresonance.io/api-reference/types/ContactEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`email`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`phoneNumber`**: `StringFilter` --- **`updatedById`**: `IDFilter` # ContactEvents Source: https://docs.firstresonance.io/api-reference/types/ContactEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Contact` --- **`oldValues`**: `Contact` --- **`timestamp`**: `DateTime` # ContactSortEnum Source: https://docs.firstresonance.io/api-reference/types/ContactSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`EMAIL_ASC`** **`EMAIL_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`PHONE_NUMBER_ASC`** **`PHONE_NUMBER_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ContactsConnection Source: https://docs.firstresonance.io/api-reference/types/ContactsConnection **Kind**: `object` ## Fields **`edges`**: `[ContactsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ContactsEdge Source: https://docs.firstresonance.io/api-reference/types/ContactsEdge A Relay edge containing a `Contacts` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Contact` The item at the end of the edge # ContactsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ContactsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ContactsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`email`**: `StringFilter` --- **`id`**: `IDFilter` --- **`locations`**: `LocationsInputFilters` --- **`name`**: `StringFilter` --- **`or_`**: `[ContactsInputFilters]` --- **`phoneNumber`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ConvertResultsFromPlanItem Source: https://docs.firstresonance.io/api-reference/types/ConvertResultsFromPlanItem Convert Runs and Purchase Order as results of Plan Item. **Kind**: `object` ## Fields **`planItem`**: `PlanItem` # ConvertResultsFromPlanItemInput Source: https://docs.firstresonance.io/api-reference/types/ConvertResultsFromPlanItemInput Input object to convert result objects from a plan item. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`inventoryIds`**: `[Int]` --- **`planItemId`**: `Int!` (required) # ConvertResultsFromPlanItems Source: https://docs.firstresonance.io/api-reference/types/ConvertResultsFromPlanItems Convert Runs and Purchase Order as results of Plan Items. **Kind**: `object` ## Fields **`planItems`**: `[PlanItem]` # ConvertResultsFromPlanItemsInput Source: https://docs.firstresonance.io/api-reference/types/ConvertResultsFromPlanItemsInput Input object to convert result objects from multiple plan items. **Kind**: `input` ## Fields **`autogenerateLotNumbers`**: `Boolean` = false --- **`autogenerateRunTitles`**: `Boolean` = false --- **`autogenerateSerialNumbers`**: `Boolean` = false --- **`batchRuns`**: `Boolean` = false --- **`planItems`**: `[ConvertResultsFromPlanItemInput]!` (required) --- **`separatePurchaseOrders`**: `Boolean` = false # CopyField Source: https://docs.firstresonance.io/api-reference/types/CopyField Copies a field to a new step given a CopyFieldInput. **Kind**: `object` ## Fields **`stepField`**: `StepField` # CopyFieldInput Source: https://docs.firstresonance.io/api-reference/types/CopyFieldInput Inputs needed to copy a field to a step. **Kind**: `input` ## Fields **`fieldId`**: `ID!` (required) --- **`stepId`**: `ID!` (required) # CopyPurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/CopyPurchaseOrder Copies a PO. **Kind**: `object` ## Fields **`purchaseOrder`**: `PurchaseOrder` # CopyPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/CopyPurchaseOrderLine Copies a PO line into the same PO or a different one. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` # CopyPurchaseOrderLineInput Source: https://docs.firstresonance.io/api-reference/types/CopyPurchaseOrderLineInput Inputs needed to copy PO line. **Kind**: `input` ## Fields **`purchaseOrderId`**: `Int` --- **`purchaseOrderLineId`**: `ID!` (required) # CopyStandardStep Source: https://docs.firstresonance.io/api-reference/types/CopyStandardStep Copies a step given a CopyStandardStepInput. **Kind**: `object` ## Fields **`step`**: `Step` # CopyStandardStepInput Source: https://docs.firstresonance.io/api-reference/types/CopyStandardStepInput Inputs needed to copy a standard step. **Kind**: `input` ## Fields **`stepId`**: `ID!` (required) # CopyStep Source: https://docs.firstresonance.io/api-reference/types/CopyStep Copies a step given a CopyStepInput. **Kind**: `object` ## Fields **`step`**: `Step` # CopyStepInput Source: https://docs.firstresonance.io/api-reference/types/CopyStepInput Inputs needed to copy a step. **Kind**: `input` ## Fields **`parentId`**: `ID` --- **`procedureId`**: `ID` --- **`stepId`**: `ID!` (required) # CopyStepToRun Source: https://docs.firstresonance.io/api-reference/types/CopyStepToRun Copies a procedure step to a run. **Kind**: `object` ## Fields **`reorderedRunSteps`**: `[RunStep]` --- **`runStep`**: `RunStep` # CopyStepToRunInput Source: https://docs.firstresonance.io/api-reference/types/CopyStepToRunInput Inputs needed to copy a step to a run. **Kind**: `input` ## Fields **`parentId`**: `ID` Parent run step id of copied step. --- **`position`**: `Int` --- **`runId`**: `ID!` (required) Destination run --- **`stepId`**: `ID!` (required) id of step to copy # CreateABomForPartInventory Source: https://docs.firstresonance.io/api-reference/types/CreateABomForPartInventory Regenerates the build requirements given a part_inventory_id. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` # CreateABomInstallation Source: https://docs.firstresonance.io/api-reference/types/CreateABomInstallation Create an ABOM Installation. **Kind**: `object` ## Fields **`abomInstallation`**: `ABomInstallation` --- **`splitInventory`**: `PartInventory` # CreateABomInstallationInput Source: https://docs.firstresonance.io/api-reference/types/CreateABomInstallationInput Inputs needed to create an ABomInstallation. **Kind**: `input` ## Fields **`actingParentPartInventoryId`**: `Int` --- **`buildRequirementId`**: `Int!` (required) --- **`buildRequirementReferenceDesignatorId`**: `Int` --- **`partInventoryId`**: `Int!` (required) --- **`quantity`**: `Float!` (required) --- **`runStepId`**: `Int` # CreateAPIKey Source: https://docs.firstresonance.io/api-reference/types/CreateAPIKey Create an API Credential Set. **Kind**: `object` ## Fields **`apikey`**: `APIKeyObject` # CreateApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/CreateApprovalLevel **Kind**: `object` ## Fields **`approvalLevel`**: `ApprovalLevel` # CreateApprovalLevelInput Source: https://docs.firstresonance.io/api-reference/types/CreateApprovalLevelInput Inputs needed to create object. **Kind**: `input` ## Fields **`costThreshold`**: `Float` --- **`isTeamSelectedLater`**: `Boolean` --- **`ordinalPosition`**: `Int` --- **`roleId`**: `Int` --- **`teamId`**: `Int` # CreateAsset Source: https://docs.firstresonance.io/api-reference/types/CreateAsset Creates an Asset given a CreateFileAttachmentInput argument. **Kind**: `object` ## Fields **`fileAttachment`**: `FileAttachment` --- **`uploadUrl`**: `String` # CreateBarcodeLabel Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodeLabel **Kind**: `object` ## Fields **`barcodeLabel`**: `BarcodeLabel` # CreateBarcodeLabelInput Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodeLabelInput **Kind**: `input` ## Fields **`entityId`**: `ID!` (required) --- **`labelPreviewId`**: `ID` --- **`templateId`**: `ID!` (required) # CreateBarcodePattern Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodePattern **Kind**: `object` ## Fields **`barcodePattern`**: `BarcodePattern` # CreateBarcodePatternInput Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodePatternInput **Kind**: `input` ## Fields **`barcodePatternJson`**: `JSONString` --- **`entityType`**: `Barcodeentitytypeenum!` (required) --- **`expression`**: `String` # CreateBarcodePrintRequest Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodePrintRequest **Kind**: `object` ## Fields **`barcodePrintRequest`**: `BarcodePrintRequest` # CreateBarcodePrintRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodePrintRequestInput Inputs needed to create a BarcodePrintRequest. **Kind**: `input` ## Fields **`barcodeLabelId`**: `Int!` (required) --- **`printerId`**: `Int` --- **`quantity`**: `Int` = 1 # CreateBarcodeTemplate Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodeTemplate **Kind**: `object` ## Fields **`barcodeTemplate`**: `BarcodeTemplate` # CreateBarcodeTemplateInput Source: https://docs.firstresonance.io/api-reference/types/CreateBarcodeTemplateInput **Kind**: `input` ## Fields **`deactivated`**: `Boolean` --- **`dpi`**: `Int` --- **`entityType`**: `Barcodeentitytypeenum!` (required) --- **`format`**: `Barcodeformatenum` --- **`heightInches`**: `Float` --- **`name`**: `String!` (required) --- **`template`**: `String` --- **`widthInches`**: `Float` # CreateBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirement **Kind**: `object` ## Fields **`buildRequirement`**: `BuildRequirement` # CreateBuildRequirementForBatch Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementForBatch Add a brand-new build requirement to the batch units that lack it. One atomic call for the "apply to the entire batch" choice, replacing a per-unit createBuildRequirement loop. Units already carrying the part are skipped (see createdCount/skippedAlreadyPresentCount). The single-unit path stays on createBuildRequirement. **Kind**: `object` ## Fields **`buildRequirements`**: `[BuildRequirement]` --- **`createdCount`**: `Int` --- **`skippedAlreadyPresentCount`**: `Int` # CreateBuildRequirementForBatchInput Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementForBatchInput Inputs to add a new BuildRequirement to every unit in a run step's batch. The batch is derived server-side from run_step_id; each unit's own assembly part_inventory_id is filled in per unit, so the caller does not pass one. **Kind**: `input` ## Fields **`madeOnAssembly`**: `Boolean!` = false --- **`partId`**: `Int!` (required) --- **`quantityPerParentPartInventory`**: `Float!` (required) --- **`runStepId`**: `Int!` (required) # CreateBuildRequirementInput Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementInput Inputs needed to create a BuildRequirement. **Kind**: `input` ## Fields **`madeOnAssembly`**: `Boolean!` = false --- **`originMbomItemId`**: `Int` --- **`partId`**: `Int!` (required) --- **`partInventoryId`**: `Int!` (required) --- **`quantityPerParentPartInventory`**: `Float!` (required) # CreateBuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementReferenceDesignator **Kind**: `object` ## Fields **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignator` # CreateBuildRequirementReferenceDesignatorInput Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementReferenceDesignatorInput Inputs needed to create a BuildRequirementReferenceDesignator. **Kind**: `input` ## Fields **`buildRequirementId`**: `Int!` (required) --- **`originMbomItemReferenceDesignatorId`**: `Int` --- **`value`**: `String!` (required) # CreateBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementSubstitute **Kind**: `object` ## Fields **`buildRequirementSubstitute`**: `BuildRequirementSubstitute` # CreateBuildRequirementSubstituteInput Source: https://docs.firstresonance.io/api-reference/types/CreateBuildRequirementSubstituteInput Inputs needed to create a BuildRequirementSubstitute. **Kind**: `input` ## Fields **`buildRequirementId`**: `Int!` (required) --- **`originMbomSubstituteId`**: `Int` --- **`partId`**: `Int!` (required) # CreateChangeOrder Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrder **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # CreateChangeOrderApproval Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderApproval **Kind**: `object` ## Fields **`approval`**: `ChangeOrderApproval` # CreateChangeOrderApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderApprovalInput Inputs needed to create a change order approval. **Kind**: `input` ## Fields **`changeOrderId`**: `ID!` (required) --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`gateType`**: `Changeorderapprovalgatetypeenum!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreateChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `ChangeOrderApprovalRequest` # CreateChangeOrderApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderApprovalRequestInput Inputs needed to create a change order approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`changeOrderId`**: `ID!` (required) --- **`gateType`**: `Changeorderapprovalgatetypeenum!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `ChangeOrderApprovalRole` # CreateChangeOrderApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderApprovalRoleInput Input needed to create a change order approval role. **Kind**: `input` ## Fields **`count`**: `Int!` (required) --- **`gateType`**: `Changeorderapprovalgatetypeenum!` (required) --- **`roleId`**: `ID!` (required) # CreateChangeOrderInput Source: https://docs.firstresonance.io/api-reference/types/CreateChangeOrderInput Inputs needed to create a change order. **Kind**: `input` ## Fields **`changeOrderType`**: `Changeordertypeenum!` (required) --- **`description`**: `String` --- **`targetEntityId`**: `Int!` (required) --- **`title`**: `String!` (required) # CreateChargeAccount Source: https://docs.firstresonance.io/api-reference/types/CreateChargeAccount **Kind**: `object` ## Fields **`chargeAccount`**: `ChargeAccount` # CreateChargeAccountInput Source: https://docs.firstresonance.io/api-reference/types/CreateChargeAccountInput Inputs needed to create a charge account. **Kind**: `input` ## Fields **`archived`**: `Boolean` --- **`code`**: `String!` (required) --- **`title`**: `String!` (required) # CreateComment Source: https://docs.firstresonance.io/api-reference/types/CreateComment **Kind**: `object` ## Fields **`comment`**: `Comment` # CreateCommentInput Source: https://docs.firstresonance.io/api-reference/types/CreateCommentInput **Kind**: `input` ## Fields **`content`**: `String` --- **`entityId`**: `ID` --- **`parentId`**: `ID` --- **`procedureFeedback`**: `Boolean` --- **`resolved`**: `Boolean` --- **`slateContent`**: `SlateContent` # CreateContact Source: https://docs.firstresonance.io/api-reference/types/CreateContact **Kind**: `object` ## Fields **`contact`**: `Contact` # CreateContactInput Source: https://docs.firstresonance.io/api-reference/types/CreateContactInput **Kind**: `input` ## Fields **`email`**: `String` --- **`name`**: `String!` (required) --- **`phoneNumber`**: `String` # CreateCurrency Source: https://docs.firstresonance.io/api-reference/types/CreateCurrency **Kind**: `object` ## Fields **`currency`**: `Currency` # CreateCurrencyInput Source: https://docs.firstresonance.io/api-reference/types/CreateCurrencyInput **Kind**: `input` ## Fields **`type`**: `String!` (required) # CreateDatagridColumn Source: https://docs.firstresonance.io/api-reference/types/CreateDatagridColumn **Kind**: `object` ## Fields **`datagridColumn`**: `DatagridColumn` # CreateDatagridColumnInput Source: https://docs.firstresonance.io/api-reference/types/CreateDatagridColumnInput **Kind**: `input` ## Fields **`Settable`**: `Boolean` --- **`allowedIonType`**: `datagridiontypeentitytypeenum` --- **`header`**: `String` --- **`index`**: `Int` --- **`options`**: `[String]` --- **`runStepId`**: `ID` --- **`settable`**: `Boolean` --- **`signoffRoleId`**: `ID` --- **`stepId`**: `ID` --- **`type`**: `datagrid_typefieldtypes!` (required) --- **`unit`**: `String` # CreateDatagridRow Source: https://docs.firstresonance.io/api-reference/types/CreateDatagridRow **Kind**: `object` ## Fields **`datagridRow`**: `DatagridRow` # CreateDatagridRowInput Source: https://docs.firstresonance.io/api-reference/types/CreateDatagridRowInput **Kind**: `input` ## Fields **`allowNotApplicable`**: `Boolean` --- **`index`**: `Int` --- **`required`**: `Boolean` --- **`runStepId`**: `ID` --- **`stepId`**: `ID` # CreateFileAttachment Source: https://docs.firstresonance.io/api-reference/types/CreateFileAttachment Creates a FileAttachment given a CreateFileAttachmentInput argument. **Kind**: `object` ## Fields **`fileAttachment`**: `FileAttachment` --- **`uploadUrl`**: `String` # CreateFileAttachmentInput Source: https://docs.firstresonance.io/api-reference/types/CreateFileAttachmentInput Inputs needed to create a FileAttachment. **Kind**: `input` ## Fields **`entityId`**: `ID` --- **`file`**: `Upload` In the future, this mutation will not support uploading files. Pass filename and use returned link to upload file on client side. --- **`filename`**: `String` --- **`integrationFetchUrl`**: `String` --- **`integrationId`**: `String` --- **`s3Etag`**: `String` --- **`s3Key`**: `String` --- **`validateUpload`**: `Boolean` # CreateFurtherAction Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherAction **Kind**: `object` ## Fields **`furtherAction`**: `FurtherAction` # CreateFurtherActionApproval Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionApproval **Kind**: `object` ## Fields **`approval`**: `FurtherActionApproval` # CreateFurtherActionApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionApprovalInput Inputs needed to create FurtherAction approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`furtherActionId`**: `ID!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreateFurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `FurtherActionApprovalRequest` # CreateFurtherActionApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionApprovalRequestInput Inputs needed to create FurtherAction approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`furtherActionId`**: `ID!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateFurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `FurtherActionApprovalRole` # CreateFurtherActionApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionApprovalRoleInput Input needed to create an approval role. **Kind**: `input` ## Fields **`count`**: `Int!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` (required) --- **`roleId`**: `ID!` (required) # CreateFurtherActionInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionInput Inputs needed to create a FurtherAction. **Kind**: `input` ## Fields **`analysisNotes`**: `SlateContent` --- **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`estimatedCompletionDate`**: `DateTime` --- **`issues`**: `[Int]` --- **`parts`**: `[Int]` --- **`problemStatement`**: `SlateContent` --- **`resolution`**: `SlateContent` --- **`runs`**: `[Int]` --- **`title`**: `String!` (required) # CreateFurtherActionIssue Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionIssue **Kind**: `object` ## Fields **`furtherActionIssue`**: `FurtherActionIssue` # CreateFurtherActionIssueInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionIssueInput Inputs needed to create a FurtherActionIssue. **Kind**: `input` ## Fields **`furtherActionId`**: `Int!` (required) --- **`issueId`**: `Int!` (required) # CreateFurtherActionPart Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionPart **Kind**: `object` ## Fields **`furtherActionPart`**: `FurtherActionPart` # CreateFurtherActionPartInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionPartInput Inputs needed to create a FurtherActionPart. **Kind**: `input` ## Fields **`furtherActionId`**: `Int!` (required) --- **`partId`**: `Int!` (required) # CreateFurtherActionRun Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionRun **Kind**: `object` ## Fields **`furtherActionRun`**: `FurtherActionRun` # CreateFurtherActionRunInput Source: https://docs.firstresonance.io/api-reference/types/CreateFurtherActionRunInput Inputs needed to create a FurtherActionRun. **Kind**: `input` ## Fields **`furtherActionId`**: `Int!` (required) --- **`runId`**: `Int!` (required) # CreateGlobalUniqueSerialNumberSchemeSettingInput Source: https://docs.firstresonance.io/api-reference/types/CreateGlobalUniqueSerialNumberSchemeSettingInput Inputs to insert part revision format and restrictions. **Kind**: `input` ## Fields **`default`**: `Boolean` = false --- **`enabled`**: `Boolean` = true --- **`etag`**: `String!` (required) --- **`exclude`**: `String` --- **`id`**: `Int!` (required) --- **`name`**: `String!` (required) --- **`serialScheme`**: `String!` (required) --- **`startAt`**: `Int` = 1 # CreateImportJob Source: https://docs.firstresonance.io/api-reference/types/CreateImportJob **Kind**: `object` ## Fields **`importJob`**: `ImportJob` # CreateImportJobInput Source: https://docs.firstresonance.io/api-reference/types/CreateImportJobInput **Kind**: `input` ## Fields **`errors`**: `JSONString` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`filename`**: `String` --- **`importDuration`**: `Int` --- **`importOptions`**: `JSONString` --- **`numRows`**: `Int` --- **`status`**: `ImportJobStatus` --- **`type`**: `Importjobtypeenum!` (required) # CreateIntentOption Source: https://docs.firstresonance.io/api-reference/types/CreateIntentOption **Kind**: `object` ## Fields **`intentOption`**: `IntentOption` # CreateIntentOptionInput Source: https://docs.firstresonance.io/api-reference/types/CreateIntentOptionInput **Kind**: `input` ## Fields **`isReceivingInspectionRunRequired`**: `Boolean` --- **`rank`**: `Int!` (required) --- **`value`**: `String!` (required) # CreateInvite Source: https://docs.firstresonance.io/api-reference/types/CreateInvite **Kind**: `object` ## Fields **`invite`**: `Invite` # CreateInviteInput Source: https://docs.firstresonance.io/api-reference/types/CreateInviteInput **Kind**: `input` ## Fields **`auth0InvitationId`**: `String` --- **`auth0OrgId`**: `String` --- **`email`**: `String!` (required) --- **`message`**: `String` --- **`name`**: `String` # CreateIssue Source: https://docs.firstresonance.io/api-reference/types/CreateIssue **Kind**: `object` ## Fields **`issue`**: `Issue` # CreateIssueApproval Source: https://docs.firstresonance.io/api-reference/types/CreateIssueApproval **Kind**: `object` ## Fields **`approval`**: `IssueApproval` # CreateIssueApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssueApprovalInput Inputs needed to create issue approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum!` (required) --- **`issueId`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreateIssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateIssueApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `IssueApprovalRequest` # CreateIssueApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssueApprovalRequestInput Inputs needed to create issue approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum!` (required) --- **`issueId`**: `ID!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateIssueDispositionType Source: https://docs.firstresonance.io/api-reference/types/CreateIssueDispositionType **Kind**: `object` ## Fields **`issueDispositionType`**: `IssueDispositionType` # CreateIssueDispositionTypeInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssueDispositionTypeInput Inputs needed to create issue disposition type roles. **Kind**: `input` ## Fields **`active`**: `Boolean!` (required) --- **`autoResolve`**: `Boolean` --- **`availabilityBehavior`**: `IssueDispositionTypeAvailabilityBehavior` --- **`description`**: `String` --- **`intentOptionId`**: `Int` --- **`title`**: `String!` (required) # CreateIssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/types/CreateIssueDispositionTypeRole **Kind**: `object` ## Fields **`issueDispositionTypeRole`**: `IssueDispositionTypeRole` # CreateIssueDispositionTypeRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssueDispositionTypeRoleInput Inputs needed to create issue disposition type roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`issueApprovalGateType`**: `Issueapprovalgatetypeenum!` (required) --- **`issueDispositionTypeId`**: `Int!` (required) --- **`roleId`**: `Int!` (required) # CreateIssueInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssueInput Inputs needed to create an Issue. **Kind**: `input` ## Fields **`addAllLotInventories`**: `Boolean` Optional. If true, adds all lot inventories to the issue. --- **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`causeCondition`**: `SlateContent` --- **`createIssueForEachBatchSibling`**: `Boolean` --- **`disposition`**: `SlateContent` --- **`expectedCondition`**: `SlateContent` --- **`fixPartInventoryId`**: `Int` --- **`issueDispositionTypeId`**: `Int` --- **`locationId`**: `Int` Optional field to move inventory on issue into new location. --- **`mustCloseByRunStepId`**: `Int` --- **`partInventoryDetails`**: `[PartInventoryQuantity]` --- **`purchaseOrderLineId`**: `Int` --- **`runStepId`**: `ID` --- **`status`**: `Issuestatusenum` --- **`title`**: `String` # CreateIssuePartInventory Source: https://docs.firstresonance.io/api-reference/types/CreateIssuePartInventory **Kind**: `object` ## Fields **`issuePartInventory`**: `IssuePartInventory` # CreateIssuePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssuePartInventoryInput Inputs needed to create IssuePartInventory. **Kind**: `input` ## Fields **`addAllLotInventories`**: `Boolean` Optional. If true, links the issue to all inventories with the same lot number and part as the provided partInventoryId. --- **`issueId`**: `Int!` (required) --- **`partInventoryId`**: `Int!` (required) # CreateIssueRelation Source: https://docs.firstresonance.io/api-reference/types/CreateIssueRelation **Kind**: `object` ## Fields **`issueRelation`**: `IssueRelation` # CreateIssueRelationInput Source: https://docs.firstresonance.io/api-reference/types/CreateIssueRelationInput **Kind**: `input` ## Fields **`originIssueId`**: `ID!` (required) --- **`relatedIssueId`**: `ID!` (required) # CreateIssues Source: https://docs.firstresonance.io/api-reference/types/CreateIssues Create issues given a list of CreateIssueInput. **Kind**: `object` ## Fields **`issues`**: `[Issue]` # CreateKitForRun Source: https://docs.firstresonance.io/api-reference/types/CreateKitForRun Create part kit based on run abom/mbom. **Kind**: `object` ## Fields **`partKit`**: `PartKit` # CreateKitForRunInput Source: https://docs.firstresonance.io/api-reference/types/CreateKitForRunInput Inputs needed to create new part kit based on run. **Kind**: `input` ## Fields **`runId`**: `ID!` (required) # CreateLabel Source: https://docs.firstresonance.io/api-reference/types/CreateLabel **Kind**: `object` ## Fields **`label`**: `Label` # CreateLabelInput Source: https://docs.firstresonance.io/api-reference/types/CreateLabelInput **Kind**: `input` ## Fields **`value`**: `String!` (required) # CreateLocation Source: https://docs.firstresonance.io/api-reference/types/CreateLocation **Kind**: `object` ## Fields **`location`**: `Location` # CreateLocationInput Source: https://docs.firstresonance.io/api-reference/types/CreateLocationInput Inputs needed to create object. **Kind**: `input` ## Fields **`address`**: `String` --- **`archived`**: `Boolean` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`available`**: `Boolean` --- **`canHoldInventory`**: `Boolean` --- **`contactId`**: `Int` --- **`description`**: `String` --- **`excludeFromMergePartInventory`**: `Boolean` Exclude the location from inventory merge (V2 merge only). --- **`imageId`**: `Int` --- **`latitude`**: `Float` --- **`locationSubtypeId`**: `Int` --- **`longitude`**: `Float` --- **`name`**: `String!` (required) --- **`parentId`**: `Int` --- **`pickSequence`**: `Int` Walk order for picking. Null falls back to name order. --- **`pickable`**: `Boolean` --- **`supervisorId`**: `Int` --- **`type`**: `Locationtypeenum` # CreateLocationSubtype Source: https://docs.firstresonance.io/api-reference/types/CreateLocationSubtype **Kind**: `object` ## Fields **`locationSubtype`**: `LocationSubtype` # CreateLocationSubtypeInput Source: https://docs.firstresonance.io/api-reference/types/CreateLocationSubtypeInput **Kind**: `input` ## Fields **`description`**: `String` --- **`name`**: `String!` (required) # CreateMBom Source: https://docs.firstresonance.io/api-reference/types/CreateMBom **Kind**: `object` ## Fields **`mbom`**: `MBom` # CreateMBomApproval Source: https://docs.firstresonance.io/api-reference/types/CreateMBomApproval **Kind**: `object` ## Fields **`approval`**: `MBomApproval` # CreateMBomApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomApprovalInput Inputs needed to create mBOM approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`gateType`**: `Mbomapprovalgatetypeenum!` (required) --- **`mbomId`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreateMBomApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateMBomApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `MBomApprovalRequest` # CreateMBomApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomApprovalRequestInput Inputs needed to create mBOM approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`gateType`**: `Mbomapprovalgatetypeenum!` (required) --- **`mbomId`**: `ID!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateMBomApprovalRole Source: https://docs.firstresonance.io/api-reference/types/CreateMBomApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `MBomApprovalRole` # CreateMBomApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomApprovalRoleInput Input needed to create an approval role. **Kind**: `input` ## Fields **`count`**: `Int!` (required) --- **`gateType`**: `Mbomapprovalgatetypeenum!` (required) --- **`roleId`**: `ID!` (required) # CreateMBomInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomInput Inputs needed to create an mBOM. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`copyMbom`**: `Boolean` If true, the new mBOM will copy from a previous version.Should not be used if mbom_id is included.Defaults to true. --- **`mbomId`**: `ID` mBOM to copy from, if supplied. mBOM to copy must be an mBOM for the same partId. --- **`partId`**: `ID!` (required) # CreateMBomItem Source: https://docs.firstresonance.io/api-reference/types/CreateMBomItem **Kind**: `object` ## Fields **`mbomItem`**: `MBomItem` # CreateMBomItemInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomItemInput Inputs needed to create an mBOM Item. **Kind**: `input` ## Fields **`excludeFromKit`**: `Boolean` --- **`madeOnAssembly`**: `Boolean` --- **`mbomId`**: `ID` --- **`parentId`**: `ID` --- **`partId`**: `ID!` (required) --- **`quantity`**: `Float!` (required) # CreateMBomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/CreateMBomItemReferenceDesignator **Kind**: `object` ## Fields **`mbomItemReferenceDesignator`**: `MBomItemReferenceDesignator` # CreateMBomItemReferenceDesignatorInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomItemReferenceDesignatorInput **Kind**: `input` ## Fields **`mbomItemId`**: `ID!` (required) --- **`value`**: `String!` (required) # CreateMBomSubstitute Source: https://docs.firstresonance.io/api-reference/types/CreateMBomSubstitute **Kind**: `object` ## Fields **`mbomSubstitute`**: `MBomSubstitute` # CreateMBomSubstituteInput Source: https://docs.firstresonance.io/api-reference/types/CreateMBomSubstituteInput Inputs needed to substitute an mBOM item. **Kind**: `input` ## Fields **`mbomItemId`**: `ID!` (required) --- **`parentId`**: `ID` --- **`partId`**: `ID!` (required) # CreateMBomSubstitutes Source: https://docs.firstresonance.io/api-reference/types/CreateMBomSubstitutes Creates mBOM substitutes given a list of CreateMBomSubstituteInputs. **Kind**: `object` ## Fields **`mbomSubstitutes`**: `[MBomSubstitute]` # CreateMRPJob Source: https://docs.firstresonance.io/api-reference/types/CreateMRPJob **Kind**: `object` ## Fields **`mrpJob`**: `MRPJob` # CreateMRPJobInput Source: https://docs.firstresonance.io/api-reference/types/CreateMRPJobInput **Kind**: `input` ## Fields **`endTime`**: `DateTime` --- **`startTime`**: `DateTime` --- **`status`**: `Jobstatusenum` # CreateManyABomInstallations Source: https://docs.firstresonance.io/api-reference/types/CreateManyABomInstallations Create many ABomInstallations atomically (all-or-nothing, input order). Per-row acting-parent audit context isn't captured in bulk — see the design doc. **Kind**: `object` ## Fields **`abomInstallations`**: `[ABomInstallation]` # CreateMbomChangeOrder Source: https://docs.firstresonance.io/api-reference/types/CreateMbomChangeOrder Create the change order for one target mBOM version. The change order arrives empty. The author adds inventories from its detail page with ``createMbomChangeOrderLines``, so they pick the version first and the scope against the diff it produces. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # CreateMbomChangeOrderInput Source: https://docs.firstresonance.io/api-reference/types/CreateMbomChangeOrderInput Inputs to create a change order naming the target mBOM version. **Kind**: `input` ## Fields **`description`**: `String` --- **`targetMbomId`**: `Int!` (required) --- **`title`**: `String!` (required) # CreateMbomChangeOrderLine Source: https://docs.firstresonance.io/api-reference/types/CreateMbomChangeOrderLine **Kind**: `object` ## Fields **`mbomChangeOrderLine`**: `MbomChangeOrderLine` # CreateMbomChangeOrderLineInput Source: https://docs.firstresonance.io/api-reference/types/CreateMbomChangeOrderLineInput Inputs needed to start one line. No target: the change order names the version, and every line on it adopts that one. **Kind**: `input` ## Fields **`changeOrderId`**: `Int!` (required) --- **`partInventoryId`**: `Int!` (required) # CreateMbomChangeOrderLines Source: https://docs.firstresonance.io/api-reference/types/CreateMbomChangeOrderLines Start one line per inventory; the target side loads once. **Kind**: `object` ## Fields **`mbomChanges`**: `[MbomChangeOrderLine]` # CreateMbomChangeOrderLinesInput Source: https://docs.firstresonance.io/api-reference/types/CreateMbomChangeOrderLinesInput Inputs needed to start many lines on one change order. **Kind**: `input` ## Fields **`changeOrderId`**: `Int!` (required) --- **`partInventoryIds`**: `[Int]!` (required) # CreateMultipleMBomItems Source: https://docs.firstresonance.io/api-reference/types/CreateMultipleMBomItems Creates multiple mBOM items given a list of CreateMBomItemInputs. **Kind**: `object` ## Fields **`mbomItems`**: `[MBomItem]` # CreateMultipleMBomItemsInput Source: https://docs.firstresonance.io/api-reference/types/CreateMultipleMBomItemsInput Input to create multiple MBom items. **Kind**: `input` ## Fields **`mbomItems`**: `[CreateMBomItemInput]` # CreateOrUpdateMultipleMBomsCsv Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleMBomsCsv Creates multiple mBOM items given a CSV file. **Kind**: `object` ## Fields **`errorMessages`**: `[MultipleMbomCreationErrors]` --- **`newMbomRowIds`**: `[Int]` # CreateOrUpdateMultipleMBomsCsvInput Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleMBomsCsvInput Input to CreateOrUpdateMultipleMBomsCsv mutation. **Kind**: `input` ## Fields **`alwaysCreateNewMbomVersion`**: `Boolean` = false --- **`commitChanges`**: `Boolean` = true --- **`importerType`**: `MBomImporterType!` (required) --- **`s3Key`**: `String!` (required) # CreateOrUpdateMultipleMBomsDepthInput Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleMBomsDepthInput mBOM bulk creation input using depth notation. Used by the mBOM importer. **Kind**: `input` ## Fields **`depth`**: `Int!` (required) --- **`madeOnAssembly`**: `Boolean!` (required) --- **`partNumber`**: `String!` (required) --- **`quantity`**: `Float!` (required) --- **`revision`**: `String!` (required) --- **`substitutes`**: `String` = "" # CreateOrUpdateMultipleMBomsLevelInput Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleMBomsLevelInput mBOM bulk creation input using level notation. Used by the mBOM importer. **Kind**: `input` ## Fields **`level`**: `String!` (required) --- **`madeOnAssembly`**: `Boolean!` (required) --- **`partNumber`**: `String!` (required) --- **`quantity`**: `Float!` (required) --- **`revision`**: `String!` (required) --- **`substitutes`**: `String` = "" # CreateOrUpdateMultipleMBomsNotationInput Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleMBomsNotationInput Input to create MBom items from importer, must be either Level or Depth notation. **Kind**: `input` ## Fields **`alwaysCreateNewMbomVersion`**: `Boolean` = false --- **`commitChanges`**: `Boolean` = true --- **`depthInputs`**: `[CreateOrUpdateMultipleMBomsDepthInput]` --- **`importerType`**: `MBomImporterType!` (required) --- **`levelInputs`**: `[CreateOrUpdateMultipleMBomsLevelInput]` # CreateOrUpdateMultipleMboms Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleMboms Creates multiple mBOM items given a list of CreateMBomItemInputs. **Kind**: `object` ## Fields **`errorMessages`**: `[MultipleMbomCreationErrors]` --- **`newMbomRowIds`**: `[Int]` # CreateOrUpdateMultipleParts Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultipleParts Create or update multiple parts from an import. **Kind**: `object` ## Fields **`parts`**: `[Part]` # CreateOrUpdateMultiplePartsInput Source: https://docs.firstresonance.io/api-reference/types/CreateOrUpdateMultiplePartsInput Input to create or update multiple parts. **Kind**: `input` ## Fields **`parts`**: `[CreatePartInput]` # CreateOrganizationDomain Source: https://docs.firstresonance.io/api-reference/types/CreateOrganizationDomain **Kind**: `object` ## Fields **`organizationDomain`**: `OrganizationDomain` # CreateOrganizationDomainInput Source: https://docs.firstresonance.io/api-reference/types/CreateOrganizationDomainInput **Kind**: `input` ## Fields **`domain`**: `String!` (required) # CreateOrganizationGlobalUniqueSerialNumberScheme Source: https://docs.firstresonance.io/api-reference/types/CreateOrganizationGlobalUniqueSerialNumberScheme Create GlobalUniqueSerialNumber in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # CreateOrganizationPartRevisionScheme Source: https://docs.firstresonance.io/api-reference/types/CreateOrganizationPartRevisionScheme Create part revision format in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # CreatePart Source: https://docs.firstresonance.io/api-reference/types/CreatePart Create a part. **Kind**: `object` ## Fields **`part`**: `Part` # CreatePartInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartInput Input to create a part. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`cost`**: `Float` --- **`description`**: `String` --- **`exportControlled`**: `Boolean` --- **`hasInventory`**: `Boolean` --- **`intentOptionId`**: `Int` --- **`leadTime`**: `Int` --- **`maintenanceIntervalSeconds`**: `Int` --- **`partNumber`**: `String!` (required) --- **`partType`**: `Parttypeenum` --- **`purchaseType`**: `purchasetypeenum` --- **`reorderMaximumQuantity`**: `Float` --- **`reorderMinimumQuantity`**: `Float` --- **`revision`**: `String` --- **`revisionScheme`**: `String` --- **`sourcingStrategy`**: `Sourcingstrategyenum` --- **`status`**: `partstatusenumpartstatusenum` --- **`supplierPartNumber`**: `String` --- **`thumbnailId`**: `ID` --- **`trackingType`**: `Trackingtypeenum` --- **`unitOfMeasureId`**: `Int` Defaults to 'each' if no UOM is passed. # CreatePartInventories Source: https://docs.firstresonance.io/api-reference/types/CreatePartInventories **Kind**: `object` ## Fields **`partInventories`**: `[PartInventory]` # CreatePartInventory Source: https://docs.firstresonance.io/api-reference/types/CreatePartInventory **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` # CreatePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartInventoryInput Inputs needed to create a PartInventory. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`autogenerateLotNumber`**: `Boolean` --- **`autogenerateSerialNumber`**: `Boolean` In the future, this input will not support a boolean 'autogenerate_serial_type'. Use autogenerate_serial_type field with SerialGeneratorType.REVISIONS --- **`autogenerateSerialType`**: `SerialGeneratorType` --- **`cost`**: `Decimal` --- **`estimatedArrival`**: `DateTime` --- **`intentOptionId`**: `Int` --- **`lastMaintainedDate`**: `DateTime` --- **`locationId`**: `ID` --- **`lotNumber`**: `String` --- **`needDate`**: `DateTime` --- **`partId`**: `ID!` (required) --- **`quantity`**: `Float` --- **`quantityScrapped`**: `Float` --- **`serialNumber`**: `String` --- **`supplierId`**: `ID` --- **`unitOfMeasureId`**: `ID` --- **`uri`**: `String` # CreatePartInventoryOnRunInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartInventoryOnRunInput Inputs needed to create a PartInventory on a run. **Kind**: `input` ## Fields **`autogenerateLotNumber`**: `Boolean` --- **`autogenerateSerialNumber`**: `Boolean` --- **`lotNumber`**: `String` --- **`partId`**: `ID!` (required) --- **`quantity`**: `Int!` (required) --- **`serialNumber`**: `String` # CreatePartKit Source: https://docs.firstresonance.io/api-reference/types/CreatePartKit **Kind**: `object` ## Fields **`partKit`**: `PartKit` # CreatePartKitInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartKitInput Inputs needed to create object. **Kind**: `input` ## Fields **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`deliveryLocationId`**: `Int` --- **`locationId`**: `Int` --- **`runId`**: `Int` --- **`status`**: `Partkitstatusenum` # CreatePartKitItem Source: https://docs.firstresonance.io/api-reference/types/CreatePartKitItem **Kind**: `object` ## Fields **`partKitItem`**: `PartKitItem` # CreatePartKitItemInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartKitItemInput Inputs needed to create object. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`originMbomItemId`**: `Int` --- **`partId`**: `Int` --- **`partKitId`**: `Int` --- **`quantity`**: `Float` # CreatePartKitItems Source: https://docs.firstresonance.io/api-reference/types/CreatePartKitItems Create PartKitItems. **Kind**: `object` ## Fields **`partKitItems`**: `[PartKitItem]` # CreatePartProcedure Source: https://docs.firstresonance.io/api-reference/types/CreatePartProcedure **Kind**: `object` ## Fields **`partProcedure`**: `PartProcedure` # CreatePartProcedureInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartProcedureInput **Kind**: `input` ## Fields **`id`**: `ID` --- **`partId`**: `ID!` (required) --- **`pinnedMbomId`**: `ID` --- **`procedureId`**: `ID!` (required) --- **`required`**: `Boolean` # CreatePartRevision Source: https://docs.firstresonance.io/api-reference/types/CreatePartRevision Create a revision for a part. **Kind**: `object` ## Fields **`part`**: `Part` # CreatePartRevisionInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartRevisionInput Inputs to create a new revision for a part. **Kind**: `input` ## Fields **`description`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`revisionScheme`**: `String` --- **`supplierPartNumber`**: `String` --- **`thumbnailId`**: `ID` --- **`trackingType`**: `Trackingtypeenum` # CreatePartRevisionSchemeSettingInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartRevisionSchemeSettingInput Inputs to insert part revision format and restrictions. **Kind**: `input` ## Fields **`allowOverflow`**: `Boolean` = false --- **`default`**: `Boolean` = false --- **`etag`**: `String!` (required) --- **`format`**: `[String]!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String!` (required) # CreatePartSubtype Source: https://docs.firstresonance.io/api-reference/types/CreatePartSubtype **Kind**: `object` ## Fields **`partSubtype`**: `PartSubtype` # CreatePartSubtypeInput Source: https://docs.firstresonance.io/api-reference/types/CreatePartSubtypeInput **Kind**: `input` ## Fields **`description`**: `String` --- **`name`**: `String!` (required) # CreatePickOverrideEvent Source: https://docs.firstresonance.io/api-reference/types/CreatePickOverrideEvent **Kind**: `object` ## Fields **`pickOverrideEvent`**: `PickOverrideEvent` # CreatePickOverrideEventInput Source: https://docs.firstresonance.io/api-reference/types/CreatePickOverrideEventInput Inputs needed to record an override. occurred_at defaults to the time of the call when the emitter does not batch. `part_id` is the PLANNED part; name the part actually taken in `chosen_part_id`. Omitting it asserts the pick stayed on the planned part, and the chosen inventory is validated against that claim. **Kind**: `input` ## Fields **`chosenLocationId`**: `ID` --- **`chosenPartId`**: `ID` --- **`chosenPartInventoryId`**: `ID!` (required) --- **`occurredAt`**: `DateTime` --- **`partId`**: `ID!` (required) --- **`partKitId`**: `ID!` (required) --- **`pickRunStopId`**: `ID` --- **`quantity`**: `Float` --- **`reason`**: `Pickoverridereasonenum` --- **`reasonText`**: `String` --- **`recommendedLocationId`**: `ID` --- **`recommendedPartInventoryId`**: `ID!` (required) --- **`surface`**: `Pickoverridesurfaceenum!` (required) # CreatePickRun Source: https://docs.firstresonance.io/api-reference/types/CreatePickRun Plan a walk across a batch of kits. **Kind**: `object` ## Fields **`pickRun`**: `PickRun` # CreatePickRunInput Source: https://docs.firstresonance.io/api-reference/types/CreatePickRunInput Which kits to plan a walk for. **Kind**: `input` ## Fields **`isBatchPick`**: `Boolean` --- **`locationId`**: `ID` --- **`partKitIds`**: `[ID]!` (required) # CreatePlan Source: https://docs.firstresonance.io/api-reference/types/CreatePlan **Kind**: `object` ## Fields **`plan`**: `Plan` # CreatePlanConstraint Source: https://docs.firstresonance.io/api-reference/types/CreatePlanConstraint **Kind**: `object` ## Fields **`planConstraint`**: `PlanConstraint` # CreatePlanConstraintInput Source: https://docs.firstresonance.io/api-reference/types/CreatePlanConstraintInput Inputs needed to create a plan constraint. **Kind**: `input` ## Fields **`locationIds`**: `[Int]!` (required) --- **`operator`**: `ConstraintOperator!` (required) --- **`planId`**: `Int!` (required) # CreatePlanInput Source: https://docs.firstresonance.io/api-reference/types/CreatePlanInput Inputs needed to create a plan. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`description`**: `String` --- **`includeInMrp`**: `Boolean` --- **`name`**: `String` # CreatePlanItem Source: https://docs.firstresonance.io/api-reference/types/CreatePlanItem **Kind**: `object` ## Fields **`planItem`**: `PlanItem` # CreatePlanItemAllocation Source: https://docs.firstresonance.io/api-reference/types/CreatePlanItemAllocation **Kind**: `object` ## Fields **`planItemAllocation`**: `PlanItemAllocation` # CreatePlanItemAllocationInput Source: https://docs.firstresonance.io/api-reference/types/CreatePlanItemAllocationInput **Kind**: `input` ## Fields **`childPlanItemId`**: `ID!` (required) --- **`mrpJobId`**: `ID` --- **`parentPlanItemId`**: `ID!` (required) --- **`quantity`**: `Float!` (required) # CreatePlanItemInput Source: https://docs.firstresonance.io/api-reference/types/CreatePlanItemInput **Kind**: `input` ## Fields **`assignedToId`**: `ID` --- **`endTime`**: `DateTime` --- **`explode`**: `Boolean` --- **`forecastedEndTime`**: `DateTime` --- **`forecastedStartTime`**: `DateTime` --- **`isBlocked`**: `Boolean` --- **`isFirm`**: `Boolean` --- **`isPlaceholder`**: `Boolean` --- **`mrpJobId`**: `ID` --- **`name`**: `String!` (required) --- **`partId`**: `ID` --- **`procedureId`**: `ID` --- **`quantity`**: `Float` --- **`startTime`**: `DateTime` --- **`supplierId`**: `ID` # CreatePlanReservation Source: https://docs.firstresonance.io/api-reference/types/CreatePlanReservation **Kind**: `object` ## Fields **`planReservation`**: `PlanReservation` # CreatePlanReservationInput Source: https://docs.firstresonance.io/api-reference/types/CreatePlanReservationInput **Kind**: `input` ## Fields **`partInventoryId`**: `ID` --- **`planId`**: `ID` --- **`quantity`**: `Float!` (required) # CreatePrintJob Source: https://docs.firstresonance.io/api-reference/types/CreatePrintJob A GraphQL mutation for creating a print job in the PrintNode system. **Kind**: `object` ## Fields **`printJobId`**: `String!` # CreatePrintJobInput Source: https://docs.firstresonance.io/api-reference/types/CreatePrintJobInput Inputs needed for a CreatePrintJob. **Kind**: `input` ## Fields **`content`**: `String!` (required) --- **`printJobTitle`**: `String` --- **`printerId`**: `Int!` (required) --- **`quantity`**: `Int` = 1 # CreateProcedure Source: https://docs.firstresonance.io/api-reference/types/CreateProcedure Creates a new Procedure. **Kind**: `object` ## Fields **`procedure`**: `Procedure` # CreateProcedureApproval Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureApproval **Kind**: `object` ## Fields **`approval`**: `ProcedureApproval` # CreateProcedureApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureApprovalInput Inputs needed to create procedure approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`gateType`**: `Procedureapprovalgatetypeenum!` (required) --- **`parentId`**: `ID` --- **`procedureId`**: `ID!` (required) --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `Int` # CreateProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `ProcedureApprovalRequest` # CreateProcedureApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureApprovalRequestInput Inputs needed to create procedure approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`gateType`**: `Procedureapprovalgatetypeenum!` (required) --- **`procedureId`**: `ID!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `ProcedureApprovalRole` # CreateProcedureApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureApprovalRoleInput Input needed to create an approval role. **Kind**: `input` ## Fields **`count`**: `Int!` (required) --- **`gateType`**: `Procedureapprovalgatetypeenum!` (required) --- **`roleId`**: `ID!` (required) # CreateProcedureInput Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureInput Inputs required to create a Procedure Attribute. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`description`**: `String` --- **`exportControlled`**: `Boolean` --- **`intentOptionId`**: `Int` --- **`title`**: `String` --- **`type`**: `Proceduretypeenum` # CreateProcedureVersion Source: https://docs.firstresonance.io/api-reference/types/CreateProcedureVersion Create a new version of a Procedure given a familyId. (optionally) Create a new version of a Procedure within the family by specifying its familyId and procedureId. **Kind**: `object` ## Fields **`procedure`**: `Procedure` # CreateProject Source: https://docs.firstresonance.io/api-reference/types/CreateProject **Kind**: `object` ## Fields **`project`**: `Project` # CreateProjectInput Source: https://docs.firstresonance.io/api-reference/types/CreateProjectInput Inputs needed to create a project. **Kind**: `input` ## Fields **`archived`**: `Boolean` --- **`code`**: `String!` (required) --- **`title`**: `String!` (required) # CreatePurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrder **Kind**: `object` ## Fields **`purchaseOrder`**: `PurchaseOrder` # CreatePurchaseOrderApproval Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderApproval **Kind**: `object` ## Fields **`approval`**: `PurchaseOrderApproval` # CreatePurchaseOrderApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderApprovalInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`parentId`**: `ID` --- **`purchaseOrderId`**: `ID!` (required) --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreatePurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderApprovalLevel **Kind**: `object` ## Fields **`purchaseOrderApprovalLevel`**: `PurchaseOrderApprovalLevel` # CreatePurchaseOrderApprovalLevelInput Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderApprovalLevelInput **Kind**: `input` ## Fields **`approvalLevelId`**: `ID!` (required) --- **`approvingUserId`**: `ID` --- **`assignedUserId`**: `ID` --- **`isTeamSelectedLater`**: `Boolean` --- **`purchaseOrderId`**: `ID!` (required) --- **`status`**: `Approvalstatusenum` --- **`teamId`**: `ID` # CreatePurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `PurchaseOrderApprovalRequest` # CreatePurchaseOrderApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderApprovalRequestInput **Kind**: `input` ## Fields **`purchaseOrderId`**: `ID!` (required) --- **`reviewerId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreatePurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderFee **Kind**: `object` ## Fields **`purchaseOrderFee`**: `PurchaseOrderFee` # CreatePurchaseOrderFeeInput Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderFeeInput **Kind**: `input` ## Fields **`name`**: `String!` (required) --- **`purchaseOrderId`**: `ID!` (required) --- **`type`**: `Feetypeenum` --- **`value`**: `Float!` (required) # CreatePurchaseOrderInput Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderInput Inputs needed to create object. **Kind**: `input` ## Fields **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`billToLocationId`**: `Int` --- **`cost`**: `Float` --- **`currencyId`**: `Int` --- **`description`**: `String` --- **`externalReference`**: `String` --- **`intentOptionId`**: `Int` --- **`orderedAt`**: `DateTime` --- **`paid`**: `Boolean` --- **`shipToLocationId`**: `Int` --- **`status`**: `Purchaseorderstatusenum` --- **`supplierId`**: `Int` --- **`supplierInstructions`**: `SlateContent` # CreatePurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderLine Creates a new Purchase Order Line. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` # CreatePurchaseOrderLineInput Source: https://docs.firstresonance.io/api-reference/types/CreatePurchaseOrderLineInput Inputs needed to create object. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`chargeAccountId`**: `ID` --- **`cost`**: `Float` --- **`description`**: `String` --- **`estimatedArrivalDate`**: `DateTime` --- **`intentOptionId`**: `Int` --- **`needDate`**: `DateTime` --- **`originalEstimatedArrivalDate`**: `DateTime` --- **`paid`**: `Boolean` --- **`partId`**: `Int` --- **`position`**: `Int` --- **`projectId`**: `ID` --- **`purchaseOrderId`**: `Int!` (required) --- **`quantity`**: `Float` --- **`runStepId`**: `Int` --- **`skipInventoryCreation`**: `Boolean` --- **`supplierPartId`**: `Int` # CreateReceipt Source: https://docs.firstresonance.io/api-reference/types/CreateReceipt **Kind**: `object` ## Fields **`receipt`**: `Receipt` # CreateReceiptInput Source: https://docs.firstresonance.io/api-reference/types/CreateReceiptInput Custom inputs to create receipt. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`receivedAt`**: `DateTime` --- **`receivedById`**: `Int` # CreateReceiptItemOnReceiptInput Source: https://docs.firstresonance.io/api-reference/types/CreateReceiptItemOnReceiptInput Adds a receipt item to the receipt. **Kind**: `input` ## Fields **`partInventory`**: `UpsertPartInventoryOnReceiptItemInput` --- **`purchaseOrderLineId`**: `Int` --- **`quantity`**: `Float!` (required) # CreateRedlineApproval Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApproval **Kind**: `object` ## Fields **`approval`**: `RedlineApproval` # CreateRedlineApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovalInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`parentId`**: `ID` --- **`redlineId`**: `ID!` (required) --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreateRedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `RedlineApprovalRequest` # CreateRedlineApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovalRequestInput **Kind**: `input` ## Fields **`redlineId`**: `ID!` (required) --- **`reviewerId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateRedlineApprovalRequests Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovalRequests **Kind**: `object` ## Fields **`approvalRequests`**: `[RedlineApprovalRequest]` # CreateRedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `RedlineApprovalRole` # CreateRedlineApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovalRoleInput Input needed to create a redline approval role. **Kind**: `input` ## Fields **`count`**: `Int!` (required) --- **`gateType`**: `Redlineapprovalgatetypeenum!` (required) --- **`roleId`**: `ID!` (required) # CreateRedlineApprovals Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineApprovals **Kind**: `object` ## Fields **`approvals`**: `[RedlineApproval]` # CreateRedlineRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineRoleBasedApproval **Kind**: `object` ## Fields **`approval`**: `RedlineRoleBasedApproval` # CreateRedlineRoleBasedApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineRoleBasedApprovalInput Inputs needed to create redline role-based approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`gateType`**: `Redlineapprovalgatetypeenum!` (required) --- **`parentId`**: `ID` --- **`redlineId`**: `ID!` (required) --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # CreateRedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineRoleBasedApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `RedlineRoleBasedApprovalRequest` # CreateRedlineRoleBasedApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineRoleBasedApprovalRequestInput Inputs needed to create redline role-based approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`gateType`**: `Redlineapprovalgatetypeenum!` (required) --- **`redlineId`**: `ID!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` # CreateRedlineRoleBasedApprovalRequests Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineRoleBasedApprovalRequests **Kind**: `object` ## Fields **`approvalRequests`**: `[RedlineRoleBasedApprovalRequest]` # CreateRedlineRoleBasedApprovals Source: https://docs.firstresonance.io/api-reference/types/CreateRedlineRoleBasedApprovals **Kind**: `object` ## Fields **`approvals`**: `[RedlineRoleBasedApproval]` # CreateRequirement Source: https://docs.firstresonance.io/api-reference/types/CreateRequirement **Kind**: `object` ## Fields **`requirement`**: `Requirement` # CreateRequirementInput Source: https://docs.firstresonance.io/api-reference/types/CreateRequirementInput **Kind**: `input` ## Fields **`content`**: `SlateContent!` (required) --- **`referenceName`**: `String` --- **`requirementType`**: `Requirementtypeenum!` (required) --- **`title`**: `String!` (required) # CreateReview Source: https://docs.firstresonance.io/api-reference/types/CreateReview **Kind**: `object` ## Fields **`review`**: `Review` # CreateReviewInput Source: https://docs.firstresonance.io/api-reference/types/CreateReviewInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`parentId`**: `ID` --- **`procedureId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID` # CreateReviewRequest Source: https://docs.firstresonance.io/api-reference/types/CreateReviewRequest Creates a ReviewRequest given a ReviewRequestInput argument. **Kind**: `object` ## Fields **`reviewRequest`**: `ReviewRequest` # CreateRole Source: https://docs.firstresonance.io/api-reference/types/CreateRole **Kind**: `object` ## Fields **`role`**: `Role` # CreateRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateRoleInput **Kind**: `input` ## Fields **`archived`**: `Boolean` --- **`name`**: `String!` (required) # CreateRule Source: https://docs.firstresonance.io/api-reference/types/CreateRule **Kind**: `object` ## Fields **`rule`**: `Rule` # CreateRuleInput Source: https://docs.firstresonance.io/api-reference/types/CreateRuleInput Inputs needed to create a rule. **Kind**: `input` ## Fields **`code`**: `String` --- **`context`**: `String` --- **`enabled`**: `Boolean` --- **`errorState`**: `RuleErrorState` --- **`eventType`**: `RuleEventType` --- **`ruleType`**: `RuleType` --- **`target`**: `RuleTargetEnum` --- **`title`**: `String` --- **`version`**: `Int` = 1 # CreateRun Source: https://docs.firstresonance.io/api-reference/types/CreateRun **Kind**: `object` ## Fields **`run`**: `Run` # CreateRunBatch Source: https://docs.firstresonance.io/api-reference/types/CreateRunBatch **Kind**: `object` ## Fields **`runBatch`**: `RunBatch` # CreateRunBatchInput Source: https://docs.firstresonance.io/api-reference/types/CreateRunBatchInput **Kind**: `input` ## Fields **`title`**: `String` # CreateRunInput Source: https://docs.firstresonance.io/api-reference/types/CreateRunInput Inputs needed to create a Run. **Kind**: `input` ## Fields **`addToNewBatch`**: `Boolean` --- **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`autogenerateTitle`**: `Boolean` --- **`bypassEnforceRunTitle`**: `Boolean` --- **`description`**: `String` --- **`dueDate`**: `DateTime` --- **`exportControlled`**: `Boolean` --- **`intentOptionId`**: `Int` --- **`newPartInventory`**: `CreatePartInventoryOnRunInput` --- **`partId`**: `ID` This field will be deprecated in a future release. Use the nested field in newPartInventory instead. --- **`partInventoryId`**: `ID` --- **`procedureId`**: `ID` --- **`quantity`**: `Int` This field will be deprecated in a future release. Use the nested field in newPartInventory instead. --- **`runBatchId`**: `Int` --- **`runBatchTitle`**: `String` --- **`title`**: `String` # CreateRunStep Source: https://docs.firstresonance.io/api-reference/types/CreateRunStep Creates a RunStep given a CreateRunStepInput argument. **Kind**: `object` ## Fields **`reorderedRunSteps`**: `[RunStep]` --- **`step`**: `RunStep` # CreateRunStepBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepBuildRequirementSubstitute **Kind**: `object` ## Fields **`runStepBuildRequirementSubstitute`**: `RunStepBuildRequirementSubstitute` # CreateRunStepBuildRequirementSubstituteInput Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepBuildRequirementSubstituteInput Inputs needed to create a RunStepBuildRequirementSubstitute. **Kind**: `input` ## Fields **`buildRequirementId`**: `Int!` (required) --- **`partId`**: `Int!` (required) --- **`runStepId`**: `Int!` (required) # CreateRunStepEdge Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepEdge **Kind**: `object` ## Fields **`stepEdge`**: `RunStepsEdge` # CreateRunStepField Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepField **Kind**: `object` ## Fields **`runStepField`**: `RunStepField` # CreateRunStepFieldInput Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepFieldInput **Kind**: `input` ## Fields **`allowNotApplicable`**: `Boolean` --- **`allowedIonType`**: `runstepfieldiontypeentitytypeenum` --- **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`display`**: `String` --- **`fileAttachmentId`**: `ID` --- **`helpText`**: `String` --- **`name`**: `String!` (required) --- **`options`**: `[String]` --- **`originFieldId`**: `ID` --- **`partId`**: `ID` --- **`partInventoryId`**: `ID` --- **`partSubtypeId`**: `ID` --- **`peerReviewRequired`**: `Boolean` --- **`position`**: `Int` --- **`required`**: `Boolean` --- **`runStepId`**: `ID!` (required) --- **`signoffRoleId`**: `ID` --- **`type`**: `runstepfieldfieldtypes!` (required) --- **`unit`**: `String` --- **`value`**: `ScalarValue` # CreateRunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepFieldValidation **Kind**: `object` ## Fields **`runStepFieldValidation`**: `RunStepFieldValidation` # CreateRunStepFieldValidationInput Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepFieldValidationInput **Kind**: `input` ## Fields **`functionId`**: `ID!` (required) --- **`position`**: `Int` --- **`runStepFieldId`**: `ID!` (required) --- **`value`**: `Float` # CreateRunStepInput Source: https://docs.firstresonance.io/api-reference/types/CreateRunStepInput Inputs needed to create a RunStep. **Kind**: `input` ## Fields **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`content`**: `String` --- **`datagrid`**: `DataGridInput` --- **`isOutsideProcess`**: `Boolean` --- **`locationId`**: `ID` --- **`parentId`**: `ID` --- **`position`**: `Int` --- **`runId`**: `ID!` (required) --- **`slateContent`**: `SlateContent` --- **`title`**: `String!` (required) --- **`type`**: `runstepsteptypes` # CreateRuns Source: https://docs.firstresonance.io/api-reference/types/CreateRuns Creates Runs given a list of CreateRunInput argument. **Kind**: `object` ## Fields **`runs`**: `[Run]` # CreateSSOSetupTicket Source: https://docs.firstresonance.io/api-reference/types/CreateSSOSetupTicket Generate a Self-Service SSO setup URL for the customer. **Kind**: `object` ## Fields **`ticket`**: `SSOTicketResult` # CreateSnapshotExportJob Source: https://docs.firstresonance.io/api-reference/types/CreateSnapshotExportJob **Kind**: `object` ## Fields **`snapshotExportJob`**: `SnapshotExportJob` # CreateSnapshotExportJobInput Source: https://docs.firstresonance.io/api-reference/types/CreateSnapshotExportJobInput **Kind**: `input` ## Fields **`destination`**: `SnapshotExportJobDestination` --- **`errors`**: `JSONString` --- **`exportDuration`**: `Int` --- **`exportFiles`**: `JSONString` --- **`exportOptions`**: `JSONString` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`fileSizeBytes`**: `Float` --- **`filename`**: `String` --- **`status`**: `SnapshotExportJobStatus` --- **`type`**: `Snapshotexportjobtypeenum!` (required) # CreateStandardStepVersion Source: https://docs.firstresonance.io/api-reference/types/CreateStandardStepVersion Create a new version of a Standard Step given a family_id. **Kind**: `object` ## Fields **`step`**: `Step` # CreateStandardStepVersionInput Source: https://docs.firstresonance.io/api-reference/types/CreateStandardStepVersionInput Inputs needed to create a standard step version. **Kind**: `input` ## Fields **`familyId`**: `Int!` (required) # CreateStep Source: https://docs.firstresonance.io/api-reference/types/CreateStep Creates a step given a CreateStepInput. **Kind**: `object` ## Fields **`step`**: `Step` # CreateStepApproval Source: https://docs.firstresonance.io/api-reference/types/CreateStepApproval **Kind**: `object` ## Fields **`approval`**: `StepApproval` # CreateStepApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepApprovalInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID!` (required) # CreateStepApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateStepApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `StepApprovalRequest` # CreateStepApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepApprovalRequestInput **Kind**: `input` ## Fields **`reviewerId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID!` (required) # CreateStepApprovalRole Source: https://docs.firstresonance.io/api-reference/types/CreateStepApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `StepApprovalRole` # CreateStepApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepApprovalRoleInput Input needed to create an approval role. **Kind**: `input` ## Fields **`count`**: `Int!` (required) --- **`gateType`**: `Stepapprovalgatetypeenum!` (required) --- **`roleId`**: `ID!` (required) # CreateStepEdge Source: https://docs.firstresonance.io/api-reference/types/CreateStepEdge **Kind**: `object` ## Fields **`stepEdge`**: `StepsEdge` # CreateStepEdgeInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepEdgeInput **Kind**: `input` ## Fields **`stepId`**: `ID!` (required) --- **`upstreamStepId`**: `ID!` (required) # CreateStepField Source: https://docs.firstresonance.io/api-reference/types/CreateStepField Creates a StepField given a CreateStepFieldInput. **Kind**: `object` ## Fields **`stepField`**: `StepField` # CreateStepFieldInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepFieldInput Inputs needed to create a StepField. **Kind**: `input` ## Fields **`allowNotApplicable`**: `Boolean` --- **`allowedIonType`**: `stepfieldiontypeentitytypeenum` --- **`display`**: `String` --- **`helpText`**: `String` --- **`name`**: `String!` (required) --- **`options`**: `[String]` --- **`partId`**: `Int` --- **`partSubtypeId`**: `Int` --- **`peerReviewRequired`**: `Boolean` --- **`required`**: `Boolean` --- **`signoffRoleId`**: `Int` --- **`stepId`**: `ID!` (required) --- **`type`**: `Fieldtypes` --- **`unit`**: `String` # CreateStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/CreateStepFieldValidation **Kind**: `object` ## Fields **`stepFieldValidation`**: `StepFieldValidation` # CreateStepFieldValidationInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepFieldValidationInput **Kind**: `input` ## Fields **`fieldId`**: `ID!` (required) --- **`functionId`**: `ID!` (required) --- **`position`**: `Int` --- **`value`**: `Float` # CreateStepInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepInput Inputs needed to create a StepField. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`content`**: `String` --- **`datagrid`**: `DataGridInput` --- **`intentOptionId`**: `Int` --- **`isOutsideProcess`**: `Boolean` --- **`leadTime`**: `Int` --- **`locationId`**: `ID` --- **`locationSubtypeId`**: `ID` --- **`parentId`**: `ID` --- **`position`**: `Int` --- **`procedureId`**: `ID` --- **`slateContent`**: `SlateContent` --- **`title`**: `String!` (required) --- **`type`**: `Steptypes` # CreateStepPartRequirement Source: https://docs.firstresonance.io/api-reference/types/CreateStepPartRequirement **Kind**: `object` ## Fields **`stepPartRequirement`**: `StepPartRequirement` # CreateStepPartRequirementInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepPartRequirementInput Inputs to create a StepPartRequirement, optionally pinning the part's MBOM first. ``pin_mbom_id`` lets a caller pin the part_procedure's MBOM version and create the assignment in one mutation so both share a single commit: if the SPR validators raise, the pin rolls back with it (the two used to commit independently). **Kind**: `input` ## Fields **`mbomItemId`**: `ID!` (required) --- **`pinMbomId`**: `ID` --- **`quantity`**: `Float!` (required) --- **`stepId`**: `ID!` (required) # CreateStepProposal Source: https://docs.firstresonance.io/api-reference/types/CreateStepProposal **Kind**: `object` ## Fields **`stepProposal`**: `StepProposal` # CreateStepProposalInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepProposalInput Inputs needed to record a proposal. **Kind**: `input` ## Fields **`baseEtag`**: `String` Etag of the proposal's write target as the caller read it — the source step, where the step renders from one. Omit to sample it at creation instead. A value naming a version the target has already moved past creates the proposal already invalidated. --- **`changeSummary`**: `String!` (required) --- **`proposedContent`**: `String` --- **`proposedSlateContent`**: `SlateContent` --- **`proposedTitle`**: `String` --- **`stepId`**: `ID!` (required) --- **`supersedesId`**: `ID` # CreateStepRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/types/CreateStepRoleBasedApproval **Kind**: `object` ## Fields **`approval`**: `StepRoleBasedApproval` # CreateStepRoleBasedApprovalInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepRoleBasedApprovalInput Inputs needed to create step role based approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`gateType`**: `Stepapprovalgatetypeenum!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID!` (required) # CreateStepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/CreateStepRoleBasedApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `StepRoleBasedApprovalRequest` # CreateStepRoleBasedApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/CreateStepRoleBasedApprovalRequestInput Inputs needed to create step role based approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`gateType`**: `Stepapprovalgatetypeenum!` (required) --- **`reviewerId`**: `ID` --- **`roleId`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID!` (required) # CreateSupplier Source: https://docs.firstresonance.io/api-reference/types/CreateSupplier **Kind**: `object` ## Fields **`supplier`**: `Supplier` # CreateSupplierInput Source: https://docs.firstresonance.io/api-reference/types/CreateSupplierInput Inputs needed to create object. **Kind**: `input` ## Fields **`address`**: `String` --- **`attributes`**: `[ExtensibleAttributeInput]` --- **`contactName`**: `String` --- **`description`**: `String` --- **`email`**: `String` --- **`name`**: `String!` (required) --- **`phoneNumber`**: `String` # CreateSupplierPart Source: https://docs.firstresonance.io/api-reference/types/CreateSupplierPart **Kind**: `object` ## Fields **`supplierPart`**: `SupplierPart` # CreateSupplierPartInput Source: https://docs.firstresonance.io/api-reference/types/CreateSupplierPartInput **Kind**: `input` ## Fields **`conversionFactor`**: `Float` --- **`cost`**: `Float` --- **`partId`**: `ID!` (required) --- **`supplierId`**: `ID!` (required) --- **`supplierPartNumber`**: `String!` (required) --- **`unitOfMeasure`**: `String` # CreateTeam Source: https://docs.firstresonance.io/api-reference/types/CreateTeam **Kind**: `object` ## Fields **`team`**: `Team` # CreateTeamInput Source: https://docs.firstresonance.io/api-reference/types/CreateTeamInput **Kind**: `input` ## Fields **`name`**: `String!` (required) --- **`supervisorId`**: `ID` # CreateUnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/types/CreateUnitOfMeasurement **Kind**: `object` ## Fields **`unitOfMeasurement`**: `UnitOfMeasurement` # CreateUnitOfMeasurementInput Source: https://docs.firstresonance.io/api-reference/types/CreateUnitOfMeasurementInput **Kind**: `input` ## Fields **`type`**: `String!` (required) # CreateUserSubscription Source: https://docs.firstresonance.io/api-reference/types/CreateUserSubscription Subscribe to updates to an entity. **Kind**: `object` ## Fields **`userSubscription`**: `UserSubscription` # CreateUserSubscriptionInput Source: https://docs.firstresonance.io/api-reference/types/CreateUserSubscriptionInput Create user subscription input. **Kind**: `input` ## Fields **`entityId`**: `ID!` (required) --- **`userId`**: `ID!` (required) # CreateWebhookHeader Source: https://docs.firstresonance.io/api-reference/types/CreateWebhookHeader **Kind**: `object` ## Fields **`webhookHeader`**: `WebhookHeader` # CreateWebhookHeaderInput Source: https://docs.firstresonance.io/api-reference/types/CreateWebhookHeaderInput **Kind**: `input` ## Fields **`key`**: `String!` (required) --- **`value`**: `String!` (required) # CreateWebhookReceiver Source: https://docs.firstresonance.io/api-reference/types/CreateWebhookReceiver **Kind**: `object` ## Fields **`webhookReceiver`**: `WebhookReceiver` # CreateWebhookReceiverInput Source: https://docs.firstresonance.io/api-reference/types/CreateWebhookReceiverInput **Kind**: `input` ## Fields **`active`**: `Boolean` --- **`contentType`**: `Webhookcontenttypesenum` --- **`description`**: `String` --- **`expectedResponseCode`**: `Int` --- **`name`**: `String!` (required) --- **`sharedSecret`**: `String` --- **`webhookUri`**: `String!` (required) # CreateWebhookSubscription Source: https://docs.firstresonance.io/api-reference/types/CreateWebhookSubscription **Kind**: `object` ## Fields **`webhookSubscription`**: `WebhookSubscription` # CreateWebhookSubscriptionInput Source: https://docs.firstresonance.io/api-reference/types/CreateWebhookSubscriptionInput **Kind**: `input` ## Fields **`action`**: `WebhookSubscriptionActions!` (required) --- **`active`**: `Boolean` --- **`receiverId`**: `ID` --- **`resource`**: `ResourceEnum!` (required) # CurrenciesConnection Source: https://docs.firstresonance.io/api-reference/types/CurrenciesConnection **Kind**: `object` ## Fields **`edges`**: `[CurrenciesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # CurrenciesEdge Source: https://docs.firstresonance.io/api-reference/types/CurrenciesEdge A Relay edge containing a `Currencies` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Currency` The item at the end of the edge # CurrenciesInputFilters Source: https://docs.firstresonance.io/api-reference/types/CurrenciesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[CurrenciesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[CurrenciesInputFilters]` --- **`type`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Currency Source: https://docs.firstresonance.io/api-reference/types/Currency Currency GraphQL object from SQLAlchemy model class. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id of creator related to Enum. Returns: int of id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `CurrencyEventFilter` --- **`type`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id of updater related to Enum. Returns: int of id # CurrencyEventFilter Source: https://docs.firstresonance.io/api-reference/types/CurrencyEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`type`**: `StringFilter` --- **`updatedById`**: `IDFilter` # CurrencyEvents Source: https://docs.firstresonance.io/api-reference/types/CurrencyEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Currency` --- **`oldValues`**: `Currency` --- **`timestamp`**: `DateTime` # CurrencySortEnum Source: https://docs.firstresonance.io/api-reference/types/CurrencySortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # CustomAttributeSortDirection Source: https://docs.firstresonance.io/api-reference/types/CustomAttributeSortDirection Sort direction for a custom-attribute value. **Kind**: `enum` ## Values **`ASC`** **`DESC`** # CustomAttributeSortInput Source: https://docs.firstresonance.io/api-reference/types/CustomAttributeSortInput Sort a record list by an org-specific custom-attribute value. **Kind**: `input` ## Fields **`direction`**: `CustomAttributeSortDirection` Sort direction. Defaults to ascending. --- **`key`**: `String!` (required) Key identifying the custom attribute to sort by. --- **`nulls`**: `CustomAttributeSortNulls` Placement of records with no value. Defaults to last in both directions. --- **`type`**: `CustomAttributeType!` (required) Expected value type; validated against the attribute definition. # CustomAttributeSortNulls Source: https://docs.firstresonance.io/api-reference/types/CustomAttributeSortNulls Placement of records missing a value for the sorted attribute. **Kind**: `enum` ## Values **`FIRST`** **`LAST`** # CustomAttributeType Source: https://docs.firstresonance.io/api-reference/types/CustomAttributeType Custom-attribute value type a sort may target. **Kind**: `enum` ## Values **`BOOLEAN`** **`DATETIME`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`STRING`** # CustomerOrganizationSummary Source: https://docs.firstresonance.io/api-reference/types/CustomerOrganizationSummary Admin-only view of a customer organization across tenant schemas. **Kind**: `object` ## Fields **`auth0OrgId`**: `String` --- **`created`**: `DateTime` --- **`domain`**: `String` --- **`id`**: `Int` --- **`name`**: `String` --- **`schemaName`**: `String` # DataGrid Source: https://docs.firstresonance.io/api-reference/types/DataGrid Datagrid with column info in metadata and grid rows in data. **Kind**: `object` ## Fields **`columns`**: `[DataGridColumnInfo]` --- **`rows`**: `[DataGridRowInfo]` # DataGridColumnInfo Source: https://docs.firstresonance.io/api-reference/types/DataGridColumnInfo Column info in a datagrid. **Kind**: `object` ## Fields **`editable`**: `Boolean` --- **`header`**: `String` --- **`id`**: `ID` --- **`options`**: `[String]` --- **`prevId`**: `ID` --- **`signoffRoleId`**: `Int` --- **`type`**: `DataGridTypeValidationsEnum` --- **`unit`**: `String` # DataGridColumnInfoInput Source: https://docs.firstresonance.io/api-reference/types/DataGridColumnInfoInput Input to create/update/delete column in a datagrid. **Kind**: `input` ## Fields **`allowedIonType`**: `datagridiontypeentitytypeenum` --- **`editable`**: `Boolean` --- **`header`**: `String` --- **`id`**: `ID` --- **`options`**: `[String]` --- **`prevId`**: `ID` --- **`signoffRoleId`**: `Int` --- **`type`**: `DataGridTypeValidationsEnum` --- **`unit`**: `String` # DataGridInput Source: https://docs.firstresonance.io/api-reference/types/DataGridInput Datagrid input type with column info in metadata and grid rows in data. **Kind**: `input` ## Fields **`columns`**: `[DataGridColumnInfoInput]` --- **`rows`**: `[DataGridRowInfoInput]` # DataGridRowInfo Source: https://docs.firstresonance.io/api-reference/types/DataGridRowInfo Column info in a datagrid. **Kind**: `object` ## Fields **`data`**: `DataGridRowScalar` --- **`id`**: `ID` --- **`prevId`**: `ID` # DataGridRowInfoInput Source: https://docs.firstresonance.io/api-reference/types/DataGridRowInfoInput Input to create/update/delete column in a datagrid. **Kind**: `input` ## Fields **`data`**: `DataGridRowScalar` --- **`id`**: `ID` --- **`prevId`**: `ID` # DataGridRowScalar Source: https://docs.firstresonance.io/api-reference/types/DataGridRowScalar Mapping of column id to column value for a particular row. **Kind**: `scalar` # DataGridTypeValidationsEnum Source: https://docs.firstresonance.io/api-reference/types/DataGridTypeValidationsEnum **Kind**: `enum` ## Values **`ARRAY`** **`BOOLEAN`** **`DATETIME`** **`MAP`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`SIGNOFF`** **`STRING`** # DatagridColumn Source: https://docs.firstresonance.io/api-reference/types/DatagridColumn Graphene sqlalchemy object type for datagrid column model. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`Settable`**: `Boolean!` --- **`_ValuesCount`**: `Int` Optimized count of values. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[DatagridColumn]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`allowedIonType`**: `datagridiontypeentitytypeenum` --- **`batchAdoptedSiblings`**: `[DatagridColumn]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[DatagridColumn]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`header`**: `String` --- **`id`**: `Int!` --- **`index`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`options`**: `[String]` --- **`parent`**: `String` --- **`prettyStr`**: `String` --- **`readOnly`**: `Boolean` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`settable`**: `Boolean` --- **`signoffRole`**: `Role` Get Role for signoff. Returns: relationship object **Arguments:** - `filters`: `RolesInputFilters` --- **`signoffRoleId`**: `Int` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `DatagridColumnEventFilter` --- **`type`**: `datagrid_typefieldtypes` --- **`unit`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`values`**: `[DatagridValue]` **Arguments:** - `filters`: `DatagridValuesInputFilters` # DatagridColumnEventFilter Source: https://docs.firstresonance.io/api-reference/types/DatagridColumnEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Settable`**: `BooleanFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `datagridiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`header`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`index`**: `IntFilter` --- **`runStepId`**: `IDFilter` --- **`signoffRoleId`**: `IDFilter` --- **`stepId`**: `IDFilter` --- **`type`**: `datagrid_typefieldtypesFilter` --- **`unit`**: `StringFilter` --- **`updatedById`**: `IDFilter` # DatagridColumnEvents Source: https://docs.firstresonance.io/api-reference/types/DatagridColumnEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `DatagridColumn` --- **`oldValues`**: `DatagridColumn` --- **`timestamp`**: `DateTime` # DatagridColumnSortEnum Source: https://docs.firstresonance.io/api-reference/types/DatagridColumnSortEnum **Kind**: `enum` ## Values **`ALLOWED_ION_TYPE_ASC`** **`ALLOWED_ION_TYPE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`HEADER_ASC`** **`HEADER_DESC`** **`ID_ASC`** **`ID_DESC`** **`INDEX_ASC`** **`INDEX_DESC`** **`OPTIONS_ASC`** **`OPTIONS_DESC`** **`RUN_STEP_ID_ASC`** **`RUN_STEP_ID_DESC`** **`SIGNOFF_ROLE_ID_ASC`** **`SIGNOFF_ROLE_ID_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UNIT_ASC`** **`UNIT_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_SETTABLE_ASC`** **`_SETTABLE_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # DatagridColumnsConnection Source: https://docs.firstresonance.io/api-reference/types/DatagridColumnsConnection **Kind**: `object` ## Fields **`edges`**: `[DatagridColumnsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # DatagridColumnsEdge Source: https://docs.firstresonance.io/api-reference/types/DatagridColumnsEdge A Relay edge containing a `DatagridColumns` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `DatagridColumn` The item at the end of the edge # DatagridColumnsInputFilters Source: https://docs.firstresonance.io/api-reference/types/DatagridColumnsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_settable`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `datagridiontypeentitytypeenumFilter` --- **`and_`**: `[DatagridColumnsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`editable`**: `BooleanFilter` --- **`header`**: `StringFilter` --- **`id`**: `IDFilter` --- **`index`**: `IntFilter` --- **`or_`**: `[DatagridColumnsInputFilters]` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepId`**: `IDFilter` --- **`settable`**: `BooleanFilter` --- **`signoffRole`**: `RolesInputFilters` --- **`signoffRoleId`**: `IDFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`type`**: `datagrid_typefieldtypesFilter` --- **`unit`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`values`**: `DatagridValuesInputFilters` # DatagridModifiedInfo Source: https://docs.firstresonance.io/api-reference/types/DatagridModifiedInfo Information about a datagrid entity (row/column) that was modified. **Kind**: `object` ## Fields **`_etag`**: `String!` --- **`id`**: `ID!` --- **`index`**: `Int!` # DatagridRow Source: https://docs.firstresonance.io/api-reference/types/DatagridRow Graphene sqlalchemy object type for datagrid row model. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_ValuesCount`**: `Int` Optimized count of values. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[DatagridRow]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`allowNotApplicable`**: `Boolean!` --- **`batchAdoptedSiblings`**: `[DatagridRow]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[DatagridRow]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `String` --- **`complete`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`id`**: `Int!` --- **`index`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `String` --- **`prettyStr`**: `String` --- **`required`**: `Boolean!` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `DatagridRowEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`values`**: `[DatagridValue]` **Arguments:** - `filters`: `DatagridValuesInputFilters` # DatagridRowEventFilter Source: https://docs.firstresonance.io/api-reference/types/DatagridRowEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowNotApplicable`**: `BooleanFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`index`**: `IntFilter` --- **`required`**: `BooleanFilter` --- **`runStepId`**: `IDFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # DatagridRowEvents Source: https://docs.firstresonance.io/api-reference/types/DatagridRowEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `DatagridRow` --- **`oldValues`**: `DatagridRow` --- **`timestamp`**: `DateTime` # DatagridRowSortEnum Source: https://docs.firstresonance.io/api-reference/types/DatagridRowSortEnum **Kind**: `enum` ## Values **`ALLOW_NOT_APPLICABLE_ASC`** **`ALLOW_NOT_APPLICABLE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`INDEX_ASC`** **`INDEX_DESC`** **`REQUIRED_ASC`** **`REQUIRED_DESC`** **`RUN_STEP_ID_ASC`** **`RUN_STEP_ID_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # DatagridRowsConnection Source: https://docs.firstresonance.io/api-reference/types/DatagridRowsConnection **Kind**: `object` ## Fields **`edges`**: `[DatagridRowsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # DatagridRowsEdge Source: https://docs.firstresonance.io/api-reference/types/DatagridRowsEdge A Relay edge containing a `DatagridRows` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `DatagridRow` The item at the end of the edge # DatagridRowsInputFilters Source: https://docs.firstresonance.io/api-reference/types/DatagridRowsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowNotApplicable`**: `BooleanFilter` --- **`and_`**: `[DatagridRowsInputFilters]` --- **`complete`**: `BooleanFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`editable`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`index`**: `IntFilter` --- **`or_`**: `[DatagridRowsInputFilters]` --- **`required`**: `BooleanFilter` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepId`**: `IDFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`values`**: `DatagridValuesInputFilters` # DatagridValue Source: https://docs.firstresonance.io/api-reference/types/DatagridValue Graphene sqlalchemy object type for datagrid value model. **Kind**: `object` ## Fields **`BooleanValue`**: `Boolean` --- **`DatetimeValue`**: `DateTime` --- **`LastSessionId`**: `String` --- **`MultiselectValues`**: `[String]` --- **`NumberValue`**: `Float` --- **`SelectValue`**: `String` --- **`StringValue`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[DatagridValue]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`batchAdoptedSiblings`**: `[DatagridValue]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[DatagridValue]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `String` --- **`column`**: `DatagridColumn` **Arguments:** - `filters`: `DatagridColumnsInputFilters` --- **`columnId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `ID` --- **`ionValue`**: `IonType` --- **`notApplicable`**: `Boolean!` --- **`partInventory`**: `PartInventory` Return part inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` Return part inventory foreign key relation. --- **`prettyStr`**: `String` --- **`row`**: `DatagridRow` **Arguments:** - `filters`: `DatagridRowsInputFilters` --- **`rowId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `DatagridValueEventFilter` --- **`type`**: `datagrid_typefieldtypes` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # DatagridValueEventFilter Source: https://docs.firstresonance.io/api-reference/types/DatagridValueEventFilter **Kind**: `input` ## Fields **`BooleanValue`**: `BooleanFilter` --- **`Created`**: `DateTimeFilter` --- **`DatetimeValue`**: `DateTimeFilter` --- **`MultiselectValues`**: `StringFilter` --- **`NumberValue`**: `FloatFilter` --- **`SelectValue`**: `StringFilter` --- **`StringValue`**: `StringFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`columnId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`notApplicable`**: `BooleanFilter` --- **`partInventoryId`**: `IDFilter` --- **`rowId`**: `IDFilter` --- **`type`**: `datagrid_typefieldtypesFilter` --- **`updatedById`**: `IDFilter` # DatagridValueEvents Source: https://docs.firstresonance.io/api-reference/types/DatagridValueEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `DatagridValue` --- **`oldValues`**: `DatagridValue` --- **`timestamp`**: `DateTime` # DatagridValueSortEnum Source: https://docs.firstresonance.io/api-reference/types/DatagridValueSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`COLUMN_ID_ASC`** **`COLUMN_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FILE_ATTACHMENT_ID_ASC`** **`FILE_ATTACHMENT_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`NOT_APPLICABLE_ASC`** **`NOT_APPLICABLE_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`ROW_ID_ASC`** **`ROW_ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_BOOLEAN_VALUE_ASC`** **`_BOOLEAN_VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_DATETIME_VALUE_ASC`** **`_DATETIME_VALUE_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_MULTISELECT_VALUES_ASC`** **`_MULTISELECT_VALUES_DESC`** **`_NUMBER_VALUE_ASC`** **`_NUMBER_VALUE_DESC`** **`_SELECT_VALUE_ASC`** **`_SELECT_VALUE_DESC`** **`_STRING_VALUE_ASC`** **`_STRING_VALUE_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # DatagridValuesConnection Source: https://docs.firstresonance.io/api-reference/types/DatagridValuesConnection **Kind**: `object` ## Fields **`edges`**: `[DatagridValuesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # DatagridValuesEdge Source: https://docs.firstresonance.io/api-reference/types/DatagridValuesEdge A Relay edge containing a `DatagridValues` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `DatagridValue` The item at the end of the edge # DatagridValuesInputFilters Source: https://docs.firstresonance.io/api-reference/types/DatagridValuesInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_boolean_value`**: `BooleanFilter` --- **`_created`**: `DateTimeFilter` --- **`_datetime_value`**: `DateTimeFilter` --- **`_multiselect_values`**: `StringFilter` --- **`_number_value`**: `FloatFilter` --- **`_select_value`**: `StringFilter` --- **`_string_value`**: `StringFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[DatagridValuesInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`column`**: `DatagridColumnsInputFilters` --- **`columnId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`ionValue`**: `IonTypeFilterInput` --- **`notApplicable`**: `BooleanFilter` --- **`or_`**: `[DatagridValuesInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`row`**: `DatagridRowsInputFilters` --- **`rowId`**: `IDFilter` --- **`type`**: `datagrid_typefieldtypesFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # DateTime Source: https://docs.firstresonance.io/api-reference/types/DateTime The `DateTime` scalar type represents a DateTime value as specified by [iso8601](https://en.wikipedia.org/wiki/ISO_8601). **Kind**: `scalar` # DateTimeFilter Source: https://docs.firstresonance.io/api-reference/types/DateTimeFilter **Kind**: `input` ## Fields **`eq`**: `DateTime` --- **`gt`**: `DateTime` --- **`gte`**: `DateTime` --- **`ilike`**: `DateTime` --- **`in`**: `[DateTime]` --- **`isnull`**: `Boolean` --- **`like`**: `DateTime` --- **`lt`**: `DateTime` --- **`lte`**: `DateTime` --- **`neq`**: `DateTime` --- **`notilike`**: `DateTime` --- **`notlike`**: `DateTime` # Decimal Source: https://docs.firstresonance.io/api-reference/types/Decimal The `Decimal` scalar type represents a python Decimal. **Kind**: `scalar` # DeleteABomInstallation Source: https://docs.firstresonance.io/api-reference/types/DeleteABomInstallation Deletes an ABomInstallation given an input object. **Kind**: `object` ## Fields **`abomInstallation`**: `ABomInstallation` # DeleteABomInstallationInput Source: https://docs.firstresonance.io/api-reference/types/DeleteABomInstallationInput Inputs needed to delete an ABomInstallation. **Kind**: `input` ## Fields **`actingParentPartInventoryId`**: `Int` --- **`buildRequirementId`**: `Int!` (required) --- **`partInventoryId`**: `Int!` (required) # DeleteAPIKey Source: https://docs.firstresonance.io/api-reference/types/DeleteAPIKey Delete an API Credential Set. **Kind**: `object` ## Fields **`apikey`**: `APIKeyObject` # DeleteApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/DeleteApprovalLevel Deletes a ApprovalLevel given an id. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteAsset Source: https://docs.firstresonance.io/api-reference/types/DeleteAsset Delete an asset. **Kind**: `object` ## Fields **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` # DeleteAttributeSettingsInput Source: https://docs.firstresonance.io/api-reference/types/DeleteAttributeSettingsInput Input to delete part attributes from organization settings. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`key`**: `String!` (required) # DeleteBarcodePattern Source: https://docs.firstresonance.io/api-reference/types/DeleteBarcodePattern **Kind**: `object` ## Fields **`id`**: `Int` # DeleteBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/DeleteBuildRequirement **Kind**: `object` ## Fields **`id`**: `Int` # DeleteBuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/DeleteBuildRequirementReferenceDesignator **Kind**: `object` ## Fields **`id`**: `Int` # DeleteBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/DeleteBuildRequirementSubstitute **Kind**: `object` ## Fields **`id`**: `Int` # DeleteChangeOrder Source: https://docs.firstresonance.io/api-reference/types/DeleteChangeOrder **Kind**: `object` ## Fields **`id`**: `Int` # DeleteChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteChangeOrderApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/types/DeleteChangeOrderApprovalRole Delete a ChangeOrderApprovalRole given an input object. **Kind**: `object` ## Fields **`approvalRole`**: `ChangeOrderApprovalRole` # DeleteChangeOrderApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteChangeOrderApprovalRoleInput Input needed to delete change order approval roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`gateType`**: `Changeorderapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # DeleteChargeAccount Source: https://docs.firstresonance.io/api-reference/types/DeleteChargeAccount **Kind**: `object` ## Fields **`id`**: `Int` # DeleteComment Source: https://docs.firstresonance.io/api-reference/types/DeleteComment **Kind**: `object` ## Fields **`id`**: `Int` # DeleteContact Source: https://docs.firstresonance.io/api-reference/types/DeleteContact **Kind**: `object` ## Fields **`id`**: `Int` # DeleteCurrency Source: https://docs.firstresonance.io/api-reference/types/DeleteCurrency **Kind**: `object` ## Fields **`id`**: `Int` # DeleteDatagridColumn Source: https://docs.firstresonance.io/api-reference/types/DeleteDatagridColumn **Kind**: `object` ## Fields **`id`**: `Int` # DeleteDatagridColumns Source: https://docs.firstresonance.io/api-reference/types/DeleteDatagridColumns Bulk delete datagrid columns. **Kind**: `object` ## Fields **`deletedIds`**: `[Int]` --- **`entitiesModified`**: `[DatagridModifiedInfo]` # DeleteDatagridEntitiesInput Source: https://docs.firstresonance.io/api-reference/types/DeleteDatagridEntitiesInput Input for deleting datagrid entities (rows/cols). **Kind**: `input` ## Fields **`ids`**: `[ID]!` (required) IDs of the entities to delete. # DeleteDatagridRow Source: https://docs.firstresonance.io/api-reference/types/DeleteDatagridRow **Kind**: `object` ## Fields **`id`**: `Int` # DeleteDatagridRows Source: https://docs.firstresonance.io/api-reference/types/DeleteDatagridRows Bulk delete datagrid rows. **Kind**: `object` ## Fields **`deletedIds`**: `[Int]` --- **`entitiesModified`**: `[DatagridModifiedInfo]` # DeleteFileAttachment Source: https://docs.firstresonance.io/api-reference/types/DeleteFileAttachment Delete a FileAttachment. **Kind**: `object` ## Fields **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` # DeleteFileAttachmentInput Source: https://docs.firstresonance.io/api-reference/types/DeleteFileAttachmentInput Inputs needed to delete a FileAttachment. **Kind**: `input` ## Fields **`entityId`**: `ID!` (required) --- **`fileAttachmentId`**: `ID!` (required) # DeleteFurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteFurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionApprovalRole Delete an FurtherActionApprovalRole given an input object. **Kind**: `object` ## Fields **`approvalRole`**: `FurtherActionApprovalRole` # DeleteFurtherActionApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionApprovalRoleInput Input needed to delete Further Action approval roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # DeleteFurtherActionIssue Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionIssue Deletes a FurtherActionIssue given an input object. **Kind**: `object` ## Fields **`furtherActionIssue`**: `FurtherActionIssue` # DeleteFurtherActionIssueInput Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionIssueInput Deletes a FurtherActionIssue given an input object. **Kind**: `input` ## Fields **`furtherActionId`**: `Int!` (required) --- **`issueId`**: `Int!` (required) # DeleteFurtherActionPart Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionPart Deletes a FurtherActionPart given an input object. **Kind**: `object` ## Fields **`furtherActionPart`**: `FurtherActionPart` # DeleteFurtherActionPartInput Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionPartInput Deletes a FurtherActionPart given an input object. **Kind**: `input` ## Fields **`furtherActionId`**: `Int!` (required) --- **`partId`**: `Int!` (required) # DeleteFurtherActionRun Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionRun Deletes a FurtherActionRun given an input object. **Kind**: `object` ## Fields **`furtherActionRun`**: `FurtherActionRun` # DeleteFurtherActionRunInput Source: https://docs.firstresonance.io/api-reference/types/DeleteFurtherActionRunInput Deletes a FurtherActionRun given an input object. **Kind**: `input` ## Fields **`furtherActionId`**: `Int!` (required) --- **`runId`**: `Int!` (required) # DeleteGlobalUniqueSerialNumberSchemeSettingInput Source: https://docs.firstresonance.io/api-reference/types/DeleteGlobalUniqueSerialNumberSchemeSettingInput Input to delete part revision from organization settings. **Kind**: `input` ## Fields **`deleteType`**: `DeleteType` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`name`**: `String!` (required) # DeleteIntentOption Source: https://docs.firstresonance.io/api-reference/types/DeleteIntentOption **Kind**: `object` ## Fields **`id`**: `Int` # DeleteIssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteIssueApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteIssueDispositionType Source: https://docs.firstresonance.io/api-reference/types/DeleteIssueDispositionType **Kind**: `object` ## Fields **`id`**: `Int` # DeleteIssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/types/DeleteIssueDispositionTypeRole Deletes an Issue Disposition Type Role given an input object. **Kind**: `object` ## Fields **`issueDispositionTypeRole`**: `IssueDispositionTypeRole` # DeleteIssueDispositionTypeRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteIssueDispositionTypeRoleInput Input needed to delete issue disposition type roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`issueApprovalGateType`**: `Issueapprovalgatetypeenum!` (required) --- **`issueDispositionTypeId`**: `Int!` (required) --- **`roleId`**: `Int!` (required) # DeleteIssuePartInventory Source: https://docs.firstresonance.io/api-reference/types/DeleteIssuePartInventory Deletes an Issue Part Inventory given an input object. **Kind**: `object` ## Fields **`issuePartInventory`**: `IssuePartInventory` # DeleteIssuePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/DeleteIssuePartInventoryInput Input needed to delete IssuePartInventory. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`issueId`**: `Int!` (required) --- **`partInventoryId`**: `Int!` (required) --- **`removeAllLotInventories`**: `Boolean` Optional. If true, deletes all issue-part-inventory links for the same part and lot number as the provided partInventoryId on this issue. # DeleteIssueRelation Source: https://docs.firstresonance.io/api-reference/types/DeleteIssueRelation **Kind**: `object` ## Fields **`originIssueId`**: `Int` --- **`relatedIssueId`**: `Int` # DeleteLabel Source: https://docs.firstresonance.io/api-reference/types/DeleteLabel **Kind**: `object` ## Fields **`id`**: `Int` # DeleteLocation Source: https://docs.firstresonance.io/api-reference/types/DeleteLocation **Kind**: `object` ## Fields **`id`**: `Int` # DeleteLocationSubtype Source: https://docs.firstresonance.io/api-reference/types/DeleteLocationSubtype **Kind**: `object` ## Fields **`id`**: `Int` # DeleteMBom Source: https://docs.firstresonance.io/api-reference/types/DeleteMBom **Kind**: `object` ## Fields **`id`**: `Int` # DeleteMBomApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteMBomApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteMBomApprovalRole Source: https://docs.firstresonance.io/api-reference/types/DeleteMBomApprovalRole Delete an MBomApprovalRole given an input object. **Kind**: `object` ## Fields **`approvalRole`**: `MBomApprovalRole` # DeleteMBomApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteMBomApprovalRoleInput Input needed to delete mBOM approval roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`gateType`**: `Mbomapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # DeleteMBomItem Source: https://docs.firstresonance.io/api-reference/types/DeleteMBomItem **Kind**: `object` ## Fields **`id`**: `Int` # DeleteMBomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/DeleteMBomItemReferenceDesignator **Kind**: `object` ## Fields **`id`**: `Int` # DeleteMBomSubstitute Source: https://docs.firstresonance.io/api-reference/types/DeleteMBomSubstitute **Kind**: `object` ## Fields **`id`**: `Int` # DeleteManyABomInstallations Source: https://docs.firstresonance.io/api-reference/types/DeleteManyABomInstallations Delete many ABomInstallations atomically. Returns the deleted pairs and the inventories whose availability was restored, so the caller does not need to refetch. **Kind**: `object` ## Fields **`deletedInstallations`**: `[DeletedABomInstallationPair]` --- **`partInventories`**: `[PartInventory]` # DeleteMbomChangeOrderLine Source: https://docs.firstresonance.io/api-reference/types/DeleteMbomChangeOrderLine **Kind**: `object` ## Fields **`id`**: `Int` # DeleteOAuthApp Source: https://docs.firstresonance.io/api-reference/types/DeleteOAuthApp Delete an OAuth application registration. **Kind**: `object` ## Fields **`oauthApp`**: `OAuthAppRegistrationObject` # DeleteOrganizationDomain Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationDomain **Kind**: `object` ## Fields **`id`**: `Int` # DeleteOrganizationFurtherActionAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationFurtherActionAttributes Delete further action attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationGlobalUniqueSerialNumberScheme Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationGlobalUniqueSerialNumberScheme Delete GlobalUniqueSerialNumber in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationIssueAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationIssueAttributes Delete issue attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationLocationAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationLocationAttributes Delete location attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationMbomAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationMbomAttributes Delete mbom attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPartAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPartAttributes Delete a part attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPartInventoryAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPartInventoryAttributes Delete a part inventory attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPartKitAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPartKitAttributes Delete a part kit attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPartKitItemAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPartKitItemAttributes Delete a part kit item attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPartRevisionScheme Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPartRevisionScheme Delete part revision format in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPlanAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPlanAttributes Delete plan attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationProcedureAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationProcedureAttributes Delete Procedure attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPurchaseOrderAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPurchaseOrderAttributes Delete purchase order attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationPurchaseOrderLineAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationPurchaseOrderLineAttributes Delete purchase order line attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationReceiptAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationReceiptAttributes Delete a receipt attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationRunAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationRunAttributes Delete a run attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationRunStepAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationRunStepAttributes Remove a run-step attribute from organization settings. Run-step and step attributes are the same attributes, so this also removes the matching step attribute. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationStepAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationStepAttributes Remove a step attribute from organization settings. Step and run-step attributes are the same attributes, so this also removes the matching run-step attribute. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeleteOrganizationSupplierAttributes Source: https://docs.firstresonance.io/api-reference/types/DeleteOrganizationSupplierAttributes Delete supplier attribute from organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # DeletePart Source: https://docs.firstresonance.io/api-reference/types/DeletePart **Kind**: `object` ## Fields **`id`**: `Int` # DeletePartInventory Source: https://docs.firstresonance.io/api-reference/types/DeletePartInventory **Kind**: `object` ## Fields **`id`**: `Int` # DeletePartInventoryBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/DeletePartInventoryBuildRequirement Deletes a PartInventoryBuildRequirement given an input object. **Kind**: `object` ## Fields **`partInventoryBuildRequirement`**: `PartInventoryBuildRequirement` # DeletePartInventoryBuildRequirementInput Source: https://docs.firstresonance.io/api-reference/types/DeletePartInventoryBuildRequirementInput Deletes a PartInventoryBuildRequirement given an input object. **Kind**: `input` ## Fields **`buildRequirementId`**: `Int!` (required) --- **`partInventoryId`**: `Int!` (required) # DeletePartKit Source: https://docs.firstresonance.io/api-reference/types/DeletePartKit **Kind**: `object` ## Fields **`id`**: `Int` # DeletePartKitItem Source: https://docs.firstresonance.io/api-reference/types/DeletePartKitItem **Kind**: `object` ## Fields **`id`**: `Int` # DeletePartProcedure Source: https://docs.firstresonance.io/api-reference/types/DeletePartProcedure **Kind**: `object` ## Fields **`partId`**: `Int` --- **`procedureId`**: `Int` # DeletePartRevisionSchemeSettingInput Source: https://docs.firstresonance.io/api-reference/types/DeletePartRevisionSchemeSettingInput Input to delete part revision from organization settings. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String!` (required) # DeletePartSubtype Source: https://docs.firstresonance.io/api-reference/types/DeletePartSubtype **Kind**: `object` ## Fields **`id`**: `Int` # DeletePlan Source: https://docs.firstresonance.io/api-reference/types/DeletePlan **Kind**: `object` ## Fields **`id`**: `Int` # DeletePlanConstraint Source: https://docs.firstresonance.io/api-reference/types/DeletePlanConstraint **Kind**: `object` ## Fields **`id`**: `Int` # DeletePlanItem Source: https://docs.firstresonance.io/api-reference/types/DeletePlanItem **Kind**: `object` ## Fields **`id`**: `Int` # DeletePlanItemAllocation Source: https://docs.firstresonance.io/api-reference/types/DeletePlanItemAllocation **Kind**: `object` ## Fields **`childPlanItemId`**: `Int` --- **`parentPlanItemId`**: `Int` # DeletePlanReservation Source: https://docs.firstresonance.io/api-reference/types/DeletePlanReservation **Kind**: `object` ## Fields **`id`**: `Int` # DeleteProcedure Source: https://docs.firstresonance.io/api-reference/types/DeleteProcedure Delete an unused procedure in draft. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteProcedureApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/types/DeleteProcedureApprovalRole Delete an ProcedureApprovalRole given an input object. **Kind**: `object` ## Fields **`approvalRole`**: `ProcedureApprovalRole` # DeleteProcedureApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteProcedureApprovalRoleInput Input needed to delete procedure approval roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`gateType`**: `Procedureapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # DeleteProcedureMBom Source: https://docs.firstresonance.io/api-reference/types/DeleteProcedureMBom Delete procedure mBOM relationship. Only if either the mBOM or procedure is in DRAFT. **Kind**: `object` ## Fields **`deletedStepPartRequirementIds`**: `[Int]` # DeleteProject Source: https://docs.firstresonance.io/api-reference/types/DeleteProject **Kind**: `object` ## Fields **`id`**: `Int` # DeletePurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/DeletePurchaseOrder Deletes a PurchaseOrder given an id. **Kind**: `object` ## Fields **`id`**: `Int` # DeletePurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/DeletePurchaseOrderApprovalLevel **Kind**: `object` ## Fields **`id`**: `Int` # DeletePurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeletePurchaseOrderApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeletePurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/types/DeletePurchaseOrderFee **Kind**: `object` ## Fields **`id`**: `Int` # DeletePurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/DeletePurchaseOrderLine Deletes a new Purchase Order Line. **Kind**: `object` ## Fields **`id`**: `Int` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` # DeleteReceipt Source: https://docs.firstresonance.io/api-reference/types/DeleteReceipt **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteRedlineApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/types/DeleteRedlineApprovalRole Delete a RedlineRoleBasedApprovalRole given an input object. **Kind**: `object` ## Fields **`approvalRole`**: `RedlineApprovalRole` # DeleteRedlineApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteRedlineApprovalRoleInput Input needed to delete redline approval roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`gateType`**: `Redlineapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # DeleteRedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteRedlineRoleBasedApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRequirement Source: https://docs.firstresonance.io/api-reference/types/DeleteRequirement **Kind**: `object` ## Fields **`id`**: `Int` # DeleteReviewRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteReviewRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRole Source: https://docs.firstresonance.io/api-reference/types/DeleteRole Deletes a role given an id. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRule Source: https://docs.firstresonance.io/api-reference/types/DeleteRule **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRunStep Source: https://docs.firstresonance.io/api-reference/types/DeleteRunStep **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/DeleteRunStepBuildRequirement Unmap a build requirement from a single run step. **Kind**: `object` ## Fields **`id`**: `String` # DeleteRunStepBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/DeleteRunStepBuildRequirementSubstitute **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRunStepEdge Source: https://docs.firstresonance.io/api-reference/types/DeleteRunStepEdge **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRunStepField Source: https://docs.firstresonance.io/api-reference/types/DeleteRunStepField **Kind**: `object` ## Fields **`id`**: `Int` # DeleteRunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/DeleteRunStepFieldValidation **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStep Source: https://docs.firstresonance.io/api-reference/types/DeleteStep Deletes a step by Id. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStepApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteStepApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStepApprovalRole Source: https://docs.firstresonance.io/api-reference/types/DeleteStepApprovalRole Delete an ProcedureApprovalRole given an input object. **Kind**: `object` ## Fields **`approvalRole`**: `StepApprovalRole` # DeleteStepApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/DeleteStepApprovalRoleInput Input needed to delete step role based approval roles. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`gateType`**: `Stepapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # DeleteStepEdge Source: https://docs.firstresonance.io/api-reference/types/DeleteStepEdge **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStepField Source: https://docs.firstresonance.io/api-reference/types/DeleteStepField Deletes a StepField given an id. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/DeleteStepFieldValidation **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStepPartRequirement Source: https://docs.firstresonance.io/api-reference/types/DeleteStepPartRequirement Delete step part requirement. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteStepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/DeleteStepRoleBasedApprovalRequest **Kind**: `object` ## Fields **`id`**: `Int` # DeleteSupplier Source: https://docs.firstresonance.io/api-reference/types/DeleteSupplier **Kind**: `object` ## Fields **`id`**: `Int` # DeleteSupplierPart Source: https://docs.firstresonance.io/api-reference/types/DeleteSupplierPart **Kind**: `object` ## Fields **`id`**: `Int` # DeleteTeam Source: https://docs.firstresonance.io/api-reference/types/DeleteTeam Deletes a team given an id. **Kind**: `object` ## Fields **`id`**: `Int` # DeleteType Source: https://docs.firstresonance.io/api-reference/types/DeleteType For multiple types of delete, typically hard/soft. **Kind**: `enum` ## Values **`HARD`** **`SOFT`** # DeleteUnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/types/DeleteUnitOfMeasurement **Kind**: `object` ## Fields **`id`**: `Int` # DeleteUserSubscription Source: https://docs.firstresonance.io/api-reference/types/DeleteUserSubscription **Kind**: `object` ## Fields **`id`**: `Int` # DeleteWebhookHeader Source: https://docs.firstresonance.io/api-reference/types/DeleteWebhookHeader **Kind**: `object` ## Fields **`id`**: `Int` # DeleteWebhookReceiver Source: https://docs.firstresonance.io/api-reference/types/DeleteWebhookReceiver **Kind**: `object` ## Fields **`id`**: `Int` # DeleteWebhookSubscription Source: https://docs.firstresonance.io/api-reference/types/DeleteWebhookSubscription **Kind**: `object` ## Fields **`id`**: `Int` # DeletedABomInstallationPair Source: https://docs.firstresonance.io/api-reference/types/DeletedABomInstallationPair The (build_requirement_id, part_inventory_id) of a deleted installation. **Kind**: `object` ## Fields **`buildRequirementId`**: `Int!` --- **`partInventoryId`**: `Int!` # DemandGapConnection Source: https://docs.firstresonance.io/api-reference/types/DemandGapConnection **Kind**: `object` ## Fields **`edges`**: `[DemandGapEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. # DemandGapEdge Source: https://docs.firstresonance.io/api-reference/types/DemandGapEdge A Relay edge containing a `DemandGap` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `DemandGapNode` The item at the end of the edge # DemandGapNode Source: https://docs.firstresonance.io/api-reference/types/DemandGapNode **Kind**: `object` ## Implements - `Node` ## Fields **`buildRequirementDemand`**: `Float` --- **`id`**: `ID!` The ID of the object. --- **`part`**: `Part` --- **`supply`**: `Float` # DemandGapsInput Source: https://docs.firstresonance.io/api-reference/types/DemandGapsInput Inputs needed to query demand gaps. **Kind**: `input` ## Fields **`buildRequirementsAgeDays`**: `Int` # DetachPermissionGroupFromRole Source: https://docs.firstresonance.io/api-reference/types/DetachPermissionGroupFromRole Detaches a Permission Group from a Role. **Kind**: `object` ## Fields **`role`**: `Role` # DetachRoleFromTeam Source: https://docs.firstresonance.io/api-reference/types/DetachRoleFromTeam Detaches a Role from a Team given a TeamToRoleInput argument. **Kind**: `object` ## Fields **`roleId`**: `Int` --- **`teamId`**: `Int` # DetachRoleFromUser Source: https://docs.firstresonance.io/api-reference/types/DetachRoleFromUser Detaches a Role from a User. **Kind**: `object` ## Fields **`roleId`**: `Int` --- **`userId`**: `Int` # DisableSSOConnection Source: https://docs.firstresonance.io/api-reference/types/DisableSSOConnection Disable SSO for the organization. **Kind**: `object` ## Fields **`success`**: `Boolean` # DismissStepProposal Source: https://docs.firstresonance.io/api-reference/types/DismissStepProposal Marks a proposal dismissed without changing its step. **Kind**: `object` ## Fields **`stepProposal`**: `StepProposal` # DispatchNotification Source: https://docs.firstresonance.io/api-reference/types/DispatchNotification Sends a notification to a particular user. **Kind**: `object` ## Fields **`response`**: `MessageResponse` # DispatchNotificationInput Source: https://docs.firstresonance.io/api-reference/types/DispatchNotificationInput Dispatch notification input. **Kind**: `input` ## Fields **`description`**: `String!` (required) --- **`linkText`**: `String!` (required) --- **`notificationType`**: `DispatchNotificationType!` (required) --- **`path`**: `String!` (required) --- **`payload`**: `JSONString` --- **`title`**: `String!` (required) --- **`userId`**: `ID!` (required) # DispatchNotificationType Source: https://docs.firstresonance.io/api-reference/types/DispatchNotificationType Dispatchable notification types. **Kind**: `enum` ## Values **`EXTERNAL`** **`SIGNOFF`** **`WARNING`** # DomainStatusEnum Source: https://docs.firstresonance.io/api-reference/types/DomainStatusEnum **Kind**: `enum` ## Values **`FAILED`** **`PENDING`** **`VERIFIED`** # DomainStatusEnumFilter Source: https://docs.firstresonance.io/api-reference/types/DomainStatusEnumFilter **Kind**: `input` ## Fields **`eq`**: `DomainStatusEnum` --- **`gt`**: `DomainStatusEnum` --- **`gte`**: `DomainStatusEnum` --- **`ilike`**: `DomainStatusEnum` --- **`in`**: `[DomainStatusEnum]` --- **`isnull`**: `Boolean` --- **`like`**: `DomainStatusEnum` --- **`lt`**: `DomainStatusEnum` --- **`lte`**: `DomainStatusEnum` --- **`neq`**: `DomainStatusEnum` --- **`notilike`**: `DomainStatusEnum` --- **`notlike`**: `DomainStatusEnum` # EmbeddedAnalytics Source: https://docs.firstresonance.io/api-reference/types/EmbeddedAnalytics Embedded analytics object. **Kind**: `object` ## Fields **`url`**: `String` # EmbeddedWorkflowBuilder Source: https://docs.firstresonance.io/api-reference/types/EmbeddedWorkflowBuilder Embedded workflow builder object. **Kind**: `object` ## Fields **`hasAccess`**: `Boolean` # EntitiesRequirement Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirement Entities requirement type. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`requirement`**: `Requirement` **Arguments:** - `filters`: `RequirementsInputFilters` --- **`requirementId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `EntitiesRequirementEventFilter` # EntitiesRequirementEventFilter Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirementEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`requirementId`**: `IDFilter` # EntitiesRequirementEvents Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirementEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `EntitiesRequirement` --- **`oldValues`**: `EntitiesRequirement` --- **`timestamp`**: `DateTime` # EntitiesRequirementSortEnum Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirementSortEnum **Kind**: `enum` ## Values **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`REQUIREMENT_ID_ASC`** **`REQUIREMENT_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # EntitiesRequirementsConnection Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirementsConnection **Kind**: `object` ## Fields **`edges`**: `[EntitiesRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # EntitiesRequirementsEdge Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirementsEdge A Relay edge containing a `EntitiesRequirements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `EntitiesRequirement` The item at the end of the edge # EntitiesRequirementsInputFilters Source: https://docs.firstresonance.io/api-reference/types/EntitiesRequirementsInputFilters **Kind**: `input` ## Fields **`_updated`**: `DateTimeFilter` --- **`and_`**: `[EntitiesRequirementsInputFilters]` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[EntitiesRequirementsInputFilters]` --- **`requirement`**: `RequirementsInputFilters` --- **`requirementId`**: `IDFilter` # Entity Source: https://docs.firstresonance.io/api-reference/types/Entity Entity relationship type. **Kind**: `object` ## Fields **`Updated`**: `DateTime` --- **`assets`**: `[FileAttachment]` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`barcodeLabels`**: `[BarcodeLabel]` **Arguments:** - `filters`: `BarcodeLabelsInputFilters` --- **`comments`**: `[Comment]` **Arguments:** - `filters`: `CommentsInputFilters` --- **`fileAttachments`**: `[FileAttachment]` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`id`**: `Float!` --- **`labels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`locations`**: `[Location]` **Arguments:** - `filters`: `LocationsInputFilters` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`requirements`**: `[Requirement]` **Arguments:** - `filters`: `RequirementsInputFilters` --- **`requirementsJoiner`**: `[EntitiesRequirement]` **Arguments:** - `filters`: `EntitiesRequirementsInputFilters` --- **`reviewRequest`**: `[ReviewRequest]` **Arguments:** - `filters`: `ReviewRequestsInputFilters` --- **`run`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`runStep`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`subscriptions`**: `[UserSubscription]` **Arguments:** - `filters`: `UserSubscriptionsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `EntityEventFilter` --- **`type`**: `Entitytypeenum!` # EntityEventFilter Source: https://docs.firstresonance.io/api-reference/types/EntityEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `FloatFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`type`**: `EntitytypeenumFilter` # EntityEvents Source: https://docs.firstresonance.io/api-reference/types/EntityEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Entity` --- **`oldValues`**: `Entity` --- **`timestamp`**: `DateTime` # EntitysInputFilters Source: https://docs.firstresonance.io/api-reference/types/EntitysInputFilters **Kind**: `input` ## Fields **`_updated`**: `DateTimeFilter` --- **`and_`**: `[EntitysInputFilters]` --- **`assets`**: `FileAttachmentsInputFilters` --- **`barcodeLabels`**: `BarcodeLabelsInputFilters` --- **`comments`**: `CommentsInputFilters` --- **`fileAttachments`**: `FileAttachmentsInputFilters` --- **`id`**: `FloatFilter` --- **`labels`**: `LabelsInputFilters` --- **`locations`**: `LocationsInputFilters` --- **`or_`**: `[EntitysInputFilters]` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`partKits`**: `PartKitsInputFilters` --- **`planItems`**: `PlanItemsInputFilters` --- **`requirements`**: `RequirementsInputFilters` --- **`requirementsJoiner`**: `EntitiesRequirementsInputFilters` --- **`reviewRequest`**: `ReviewRequestsInputFilters` --- **`run`**: `RunsInputFilters` --- **`runStep`**: `RunStepsInputFilters` --- **`subscriptions`**: `UserSubscriptionsInputFilters` --- **`type`**: `EntitytypeenumFilter` # Entitytypeenum Source: https://docs.firstresonance.io/api-reference/types/Entitytypeenum **Kind**: `enum` ## Values **`CHANGE_ORDERS`** **`CHANGE_ORDER_APPROVALS`** **`CHANGE_ORDER_APPROVAL_REQUESTS`** **`FURTHER_ACTIONS`** **`FURTHER_ACTION_APPROVALS`** **`FURTHER_ACTION_APPROVAL_REQUESTS`** **`ISSUES`** **`ISSUE_APPROVALS`** **`ISSUE_APPROVAL_REQUESTS`** **`LOCATIONS`** **`MBOMS`** **`MBOM_APPROVALS`** **`MBOM_APPROVAL_REQUESTS`** **`MRP_JOBS`** **`PARTS`** **`PARTS_INVENTORY`** **`PARTS_KITS`** **`PART_KIT_ITEMS`** **`PLANS`** **`PLAN_INPUTS`** **`PLAN_ITEMS`** **`PROCEDURES`** **`PROCEDURE_APPROVALS`** **`PROCEDURE_APPROVAL_REQUESTS`** **`PROJECTS`** **`PURCHASE_ORDERS`** **`PURCHASE_ORDER_APPROVALS`** **`PURCHASE_ORDER_APPROVAL_REQUESTS`** **`PURCHASE_ORDER_LINES`** **`RECEIPTS`** **`REDLINE_APPROVALS`** **`REDLINE_APPROVAL_REQUESTS`** **`REDLINE_ROLE_BASED_APPROVALS`** **`REDLINE_ROLE_BASED_APPROVAL_REQUESTS`** **`REVIEWS`** **`REVIEW_REQUESTS`** **`RUNS`** **`RUN_STEPS`** **`STEPS`** **`STEP_APPROVALS`** **`STEP_APPROVAL_REQUESTS`** **`STEP_ROLE_BASED_APPROVALS`** **`STEP_ROLE_BASED_APPROVAL_REQUESTS`** **`SUPPLIERS`** **`UNATTACHED`** **`USERS`** # EntitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/EntitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Entitytypeenum` --- **`gt`**: `Entitytypeenum` --- **`gte`**: `Entitytypeenum` --- **`ilike`**: `Entitytypeenum` --- **`in`**: `[Entitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Entitytypeenum` --- **`lt`**: `Entitytypeenum` --- **`lte`**: `Entitytypeenum` --- **`neq`**: `Entitytypeenum` --- **`notilike`**: `Entitytypeenum` --- **`notlike`**: `Entitytypeenum` # EventType Source: https://docs.firstresonance.io/api-reference/types/EventType Enum class for event types. **Kind**: `enum` ## Values **`CONNECTED`** **`CREATE`** **`DELETE`** **`DETACHED`** **`UPDATE`** # EventTypeFilter Source: https://docs.firstresonance.io/api-reference/types/EventTypeFilter **Kind**: `input` ## Fields **`eq`**: `EventType` --- **`gt`**: `EventType` --- **`gte`**: `EventType` --- **`ilike`**: `EventType` --- **`in`**: `[EventType]` --- **`isnull`**: `Boolean` --- **`like`**: `EventType` --- **`lt`**: `EventType` --- **`lte`**: `EventType` --- **`neq`**: `EventType` --- **`notilike`**: `EventType` --- **`notlike`**: `EventType` # Eventtypeenum Source: https://docs.firstresonance.io/api-reference/types/Eventtypeenum **Kind**: `enum` ## Values **`CHECK_IN`** **`CHECK_OUT`** # EventtypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/EventtypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Eventtypeenum` --- **`gt`**: `Eventtypeenum` --- **`gte`**: `Eventtypeenum` --- **`ilike`**: `Eventtypeenum` --- **`in`**: `[Eventtypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Eventtypeenum` --- **`lt`**: `Eventtypeenum` --- **`lte`**: `Eventtypeenum` --- **`neq`**: `Eventtypeenum` --- **`notilike`**: `Eventtypeenum` --- **`notlike`**: `Eventtypeenum` # ExtensibleAttributeInput Source: https://docs.firstresonance.io/api-reference/types/ExtensibleAttributeInput Input to create an attribute on creation. **Kind**: `input` ## Fields **`key`**: `String!` (required) --- **`value`**: `ScalarValue` # Feetypeenum Source: https://docs.firstresonance.io/api-reference/types/Feetypeenum **Kind**: `enum` ## Values **`CURRENCY`** **`PERCENTAGE`** # FeetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/FeetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Feetypeenum` --- **`gt`**: `Feetypeenum` --- **`gte`**: `Feetypeenum` --- **`ilike`**: `Feetypeenum` --- **`in`**: `[Feetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Feetypeenum` --- **`lt`**: `Feetypeenum` --- **`lte`**: `Feetypeenum` --- **`neq`**: `Feetypeenum` --- **`notilike`**: `Feetypeenum` --- **`notlike`**: `Feetypeenum` # FieldHistoriesConnection Source: https://docs.firstresonance.io/api-reference/types/FieldHistoriesConnection **Kind**: `object` ## Fields **`edges`**: `[FieldHistoriesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FieldHistoriesEdge Source: https://docs.firstresonance.io/api-reference/types/FieldHistoriesEdge A Relay edge containing a `FieldHistories` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FieldHistory` The item at the end of the edge # FieldHistoriesInputFilters Source: https://docs.firstresonance.io/api-reference/types/FieldHistoriesInputFilters FieldHistory filterable fields. **Kind**: `input` ## Fields **`and_`**: `[FieldHistoriesInputFilters]` --- **`fieldName`**: `StringFilter` --- **`id`**: `StringFilter` --- **`modelId`**: `FloatFilter` --- **`modelType`**: `StringFilter` --- **`or_`**: `[FieldHistoriesInputFilters]` --- **`sensitivity`**: `Int` --- **`sensitivityUnit`**: `FieldHistorySensitivityUnit` --- **`tableName`**: `StringFilter` --- **`timestamp`**: `DateTimeFilter` --- **`userId`**: `IntFilter` --- **`value`**: `JSONStringNullFilter` # FieldHistory Source: https://docs.firstresonance.io/api-reference/types/FieldHistory Field Histories. **Kind**: `object` ## Fields **`fieldName`**: `String` --- **`id`**: `String!` --- **`modelId`**: `Float` --- **`modelType`**: `String` --- **`tableName`**: `String` --- **`timestamp`**: `DateTime` --- **`userId`**: `Int` --- **`value`**: `JSONString` # FieldHistorySensitivityUnit Source: https://docs.firstresonance.io/api-reference/types/FieldHistorySensitivityUnit Period unit to get the latest revision of values. **Kind**: `enum` ## Values **`days`** **`hours`** **`minutes`** **`seconds`** # FieldHistorySortEnum Source: https://docs.firstresonance.io/api-reference/types/FieldHistorySortEnum **Kind**: `enum` ## Values **`FIELD_NAME_ASC`** **`FIELD_NAME_DESC`** **`ID_ASC`** **`ID_DESC`** **`MODEL_ID_ASC`** **`MODEL_ID_DESC`** **`MODEL_TYPE_ASC`** **`MODEL_TYPE_DESC`** **`TABLE_NAME_ASC`** **`TABLE_NAME_DESC`** **`TIMESTAMP_ASC`** **`TIMESTAMP_DESC`** **`USER_ID_ASC`** **`USER_ID_DESC`** # FieldsConnection Source: https://docs.firstresonance.io/api-reference/types/FieldsConnection **Kind**: `object` ## Fields **`edges`**: `[FieldsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FieldsEdge Source: https://docs.firstresonance.io/api-reference/types/FieldsEdge A Relay edge containing a `Fields` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepField` The item at the end of the edge # FieldsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FieldsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowNotApplicable`**: `BooleanFilter` --- **`allowedIonType`**: `stepfieldiontypeentitytypeenumFilter` --- **`and_`**: `[FieldsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`display`**: `StringFilter` --- **`helpText`**: `StringFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[FieldsInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partSubtype`**: `PartSubtypesInputFilters` --- **`partSubtypeId`**: `IDFilter` --- **`peerReviewRequired`**: `BooleanFilter` --- **`position`**: `IntFilter` --- **`required`**: `BooleanFilter` --- **`signoffRole`**: `RolesInputFilters` --- **`signoffRoleId`**: `IDFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`type`**: `FieldtypesFilter` --- **`unit`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`validations`**: `StepFieldValidationsInputFilters` # Fieldtypes Source: https://docs.firstresonance.io/api-reference/types/Fieldtypes **Kind**: `enum` ## Values **`BOOLEAN`** **`DATETIME`** **`FILE_ATTACHMENT`** **`ION`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`SIGNOFF`** **`STRING`** **`TOOL`** # FieldtypesFilter Source: https://docs.firstresonance.io/api-reference/types/FieldtypesFilter **Kind**: `input` ## Fields **`eq`**: `Fieldtypes` --- **`gt`**: `Fieldtypes` --- **`gte`**: `Fieldtypes` --- **`ilike`**: `Fieldtypes` --- **`in`**: `[Fieldtypes]` --- **`isnull`**: `Boolean` --- **`like`**: `Fieldtypes` --- **`lt`**: `Fieldtypes` --- **`lte`**: `Fieldtypes` --- **`neq`**: `Fieldtypes` --- **`notilike`**: `Fieldtypes` --- **`notlike`**: `Fieldtypes` # FileAttachment Source: https://docs.firstresonance.io/api-reference/types/FileAttachment A fileAttachment. Associated with a Step, RunStep, Parts, Runs, Procedures, StepsFields and RunStepsFields. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssetEntitiesCount`**: `Int` Optimized count of assetEntities. --- **`_FileAttachmentEntitiesCount`**: `Int` Optimized count of fileAttachmentEntities. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assetEntities`**: `[Entity]` **Arguments:** - `filters`: `EntitysInputFilters` --- **`contentType`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`downloadUrl`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`file`**: `String` --- **`fileAttachmentEntities`**: `[Entity]` **Arguments:** - `filters`: `EntitysInputFilters` --- **`fileLocation`**: `String` --- **`filename`**: `String` --- **`id`**: `Int!` --- **`integrationFetchUrl`**: `String` --- **`integrationId`**: `String` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`provider`**: `Filestorageproviderenum!` --- **`runStepField`**: `[RunStepField]` **Arguments:** - `filters`: `RunStepFieldInputFilters` --- **`s3Bucket`**: `String` Deprecated field in favor of the column 'fileLocation'. --- **`s3Key`**: `String` Deprecated field in favor of the column 'file'. --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FileAttachmentEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`url`**: `String` To prevent confusion between uploadUrl and downloadUrl, renaming from url to downloadUrl. > Deprecated: Deprecated in favor of more specific downloadUrl. # FileAttachmentEventFilter Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`file`**: `StringFilter` --- **`fileLocation`**: `StringFilter` --- **`filename`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`integrationFetchUrl`**: `StringFilter` --- **`integrationId`**: `StringFilter` --- **`provider`**: `FilestorageproviderenumFilter` --- **`s3Bucket`**: `StringFilter` --- **`s3Key`**: `StringFilter` --- **`updatedById`**: `IDFilter` # FileAttachmentEvents Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FileAttachment` --- **`oldValues`**: `FileAttachment` --- **`timestamp`**: `DateTime` # FileAttachmentSortEnum Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FILENAME_ASC`** **`FILENAME_DESC`** **`FILE_ASC`** **`FILE_DESC`** **`FILE_LOCATION_ASC`** **`FILE_LOCATION_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTEGRATION_FETCH_URL_ASC`** **`INTEGRATION_FETCH_URL_DESC`** **`INTEGRATION_ID_ASC`** **`INTEGRATION_ID_DESC`** **`PROVIDER_ASC`** **`PROVIDER_DESC`** **`S3_BUCKET_ASC`** **`S3_BUCKET_DESC`** **`S3_KEY_ASC`** **`S3_KEY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FileAttachmentToItemInput Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentToItemInput Inputs to attach a file attachment to an object through its entity id. **Kind**: `input` ## Fields **`entityId`**: `ID!` (required) --- **`fileAttachmentId`**: `ID!` (required) # FileAttachmentsConnection Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentsConnection **Kind**: `object` ## Fields **`edges`**: `[FileAttachmentsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FileAttachmentsEdge Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentsEdge A Relay edge containing a `FileAttachments` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FileAttachment` The item at the end of the edge # FileAttachmentsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FileAttachmentsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FileAttachmentsInputFilters]` --- **`assetEntities`**: `EntitysInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`file`**: `StringFilter` --- **`fileAttachmentEntities`**: `EntitysInputFilters` --- **`fileLocation`**: `StringFilter` --- **`filename`**: `StringFilter` --- **`id`**: `IDFilter` --- **`integrationFetchUrl`**: `StringFilter` --- **`integrationId`**: `StringFilter` --- **`or_`**: `[FileAttachmentsInputFilters]` --- **`provider`**: `FilestorageproviderenumFilter` --- **`runStepField`**: `RunStepFieldInputFilters` --- **`s3Bucket`**: `StringFilter` --- **`s3Key`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Filestorageproviderenum Source: https://docs.firstresonance.io/api-reference/types/Filestorageproviderenum **Kind**: `enum` ## Values **`AWS_S3`** **`AZURE_BLOB`** # FilestorageproviderenumFilter Source: https://docs.firstresonance.io/api-reference/types/FilestorageproviderenumFilter **Kind**: `input` ## Fields **`eq`**: `Filestorageproviderenum` --- **`gt`**: `Filestorageproviderenum` --- **`gte`**: `Filestorageproviderenum` --- **`ilike`**: `Filestorageproviderenum` --- **`in`**: `[Filestorageproviderenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Filestorageproviderenum` --- **`lt`**: `Filestorageproviderenum` --- **`lte`**: `Filestorageproviderenum` --- **`neq`**: `Filestorageproviderenum` --- **`notilike`**: `Filestorageproviderenum` --- **`notlike`**: `Filestorageproviderenum` # FloatFilter Source: https://docs.firstresonance.io/api-reference/types/FloatFilter **Kind**: `input` ## Fields **`eq`**: `Float` --- **`gt`**: `Float` --- **`gte`**: `Float` --- **`ilike`**: `Float` --- **`in`**: `[Float]` --- **`isnull`**: `Boolean` --- **`like`**: `Float` --- **`lt`**: `Float` --- **`lte`**: `Float` --- **`neq`**: `Float` --- **`notilike`**: `Float` --- **`notlike`**: `Float` # FulfillPickRunStop Source: https://docs.firstresonance.io/api-reference/types/FulfillPickRunStop Issue one stop's stock into its kits, atomically. **Kind**: `object` ## Fields **`kittedInventories`**: `[PartInventory]` --- **`pickRunStop`**: `PickRunStop` # FulfillPickRunStopInput Source: https://docs.firstresonance.io/api-reference/types/FulfillPickRunStopInput The stop being picked, and what was pulled. Omitting `confirmations` fulfils every split as planned. Supplying it reports what was pulled, and any allocation left out is short-picked to zero. A confirmation may also name the lot that satisfied it, which is how a substitution is recorded — one transaction, no separate issue call. **Kind**: `input` ## Fields **`confirmations`**: `[PickRunStopConfirmationInput]` --- **`etag`**: `String!` (required) --- **`scannedPartInventoryId`**: `ID` --- **`stopId`**: `ID!` (required) # FurtherAction Source: https://docs.firstresonance.io/api-reference/types/FurtherAction A further action object. **Kind**: `object` ## Fields **`Attributes`**: `[FurtherActionAttribute]` **Arguments:** - `filters`: `FurtherActionAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartsCount`**: `Int` Optimized count of parts. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`analysisNotes`**: `SlateContent` --- **`approvalRequests`**: `[FurtherActionApprovalRequest]` **Arguments:** - `filters`: `FurtherActionApprovalRequestsInputFilters` --- **`approvals`**: `[FurtherActionApproval]` **Arguments:** - `filters`: `FurtherActionApprovalsInputFilters` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[FurtherActionAttributedPart]` **Arguments:** - `filters`: `FurtherActionAttributedPartsInputFilters` --- **`attributedUsers`**: `[FurtherActionAttributedUser]` **Arguments:** - `filters`: `FurtherActionAttributedUsersInputFilters` --- **`attributes`**: `[FurtherActionAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`estimatedCompletionDate`**: `DateTime` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`prettyStr`**: `String` --- **`problemStatement`**: `SlateContent` --- **`resolution`**: `SlateContent` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`status`**: `Furtheractionstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionApproval Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApproval An approval related to an FurtherAction. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `FurtherActionApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[FurtherActionApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`furtherActionId`**: `IDFilter` --- **`gateType`**: `FurtheractionapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # FurtherActionApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionApproval` --- **`oldValues`**: `FurtherActionApproval` --- **`timestamp`**: `DateTime` # FurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequest A request to approve an FurtherAction. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`furtherActionId`**: `IDFilter` --- **`gateType`**: `FurtheractionapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # FurtherActionApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionApprovalRequest` --- **`oldValues`**: `FurtherActionApprovalRequest` --- **`timestamp`**: `DateTime` # FurtherActionApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FURTHER_ACTION_ID_ASC`** **`FURTHER_ACTION_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequestsEdge A Relay edge containing a `FurtherActionApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherActionApprovalRequest` The item at the end of the edge # FurtherActionApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRequestsInputFilters FurtherActionApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FurtherActionApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`furtherAction`**: `FurtherActionsInputFilters` --- **`furtherActionId`**: `IDFilter` --- **`gateType`**: `FurtheractionapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[FurtherActionApprovalRequestsInputFilters]` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # FurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRole Approval role type for FurtherAction. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionApprovalRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionApprovalRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `FurtheractionapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # FurtherActionApprovalRoleEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionApprovalRole` --- **`oldValues`**: `FurtherActionApprovalRole` --- **`timestamp`**: `DateTime` # FurtherActionApprovalRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionApprovalRolesConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRolesConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionApprovalRolesEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRolesEdge A Relay edge containing a `FurtherActionApprovalRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherActionApprovalRole` The item at the end of the edge # FurtherActionApprovalRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalRolesInputFilters FurtherActionApprovalRole filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FurtherActionApprovalRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`gateType`**: `FurtheractionapprovalgatetypeenumFilter` --- **`or_`**: `[FurtherActionApprovalRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # FurtherActionApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FURTHER_ACTION_ID_ASC`** **`FURTHER_ACTION_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalsEdge A Relay edge containing a `FurtherActionApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherActionApproval` The item at the end of the edge # FurtherActionApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionApprovalsInputFilters FurtherActionApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FurtherActionApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`furtherAction`**: `FurtherActionsInputFilters` --- **`furtherActionId`**: `IDFilter` --- **`gateType`**: `FurtheractionapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[FurtherActionApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # FurtherActionAttribute Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int` --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # FurtherActionAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`furtherActionId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # FurtherActionAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionAttribute` --- **`oldValues`**: `FurtherActionAttribute` --- **`timestamp`**: `DateTime` # FurtherActionAttributedPart Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributedPart Auto-generated GQL type for FurtherActionAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # FurtherActionAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[FurtherActionAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[FurtherActionAttributedPartsInputFilters]` # FurtherActionAttributedUser Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributedUser Auto-generated GQL type for FurtherActionAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # FurtherActionAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[FurtherActionAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[FurtherActionAttributedUsersInputFilters]` # FurtherActionAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[FurtherActionAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`furtherAction`**: `FurtherActionsInputFilters` --- **`furtherActionId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[FurtherActionAttributesInputFilters]` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # FurtherActionEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`analysisNotes`**: `SlateContentFilter` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`estimatedCompletionDate`**: `DateTimeFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`problemStatement`**: `SlateContentFilter` --- **`resolution`**: `SlateContentFilter` --- **`status`**: `FurtheractionstatusenumFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # FurtherActionEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherAction` --- **`oldValues`**: `FurtherAction` --- **`timestamp`**: `DateTime` # FurtherActionIssue Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssue A further action issue object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`id`**: `ID` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionIssueEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionIssueEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssueEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`furtherActionId`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # FurtherActionIssueEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssueEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionIssue` --- **`oldValues`**: `FurtherActionIssue` --- **`timestamp`**: `DateTime` # FurtherActionIssueSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssueSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FURTHER_ACTION_ID_ASC`** **`FURTHER_ACTION_ID_DESC`** **`ISSUE_ID_ASC`** **`ISSUE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionIssuesConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssuesConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionIssuesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionIssuesEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssuesEdge A Relay edge containing a `FurtherActionIssues` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherActionIssue` The item at the end of the edge # FurtherActionIssuesInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionIssuesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FurtherActionIssuesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`furtherAction`**: `FurtherActionsInputFilters` --- **`furtherActionId`**: `IDFilter` --- **`issue`**: `IssueInputFilters` --- **`issueId`**: `IDFilter` --- **`or_`**: `[FurtherActionIssuesInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # FurtherActionPart Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPart A further action part object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`id`**: `ID` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionPartEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionPartEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPartEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`furtherActionId`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # FurtherActionPartEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPartEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionPart` --- **`oldValues`**: `FurtherActionPart` --- **`timestamp`**: `DateTime` # FurtherActionPartSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPartSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FURTHER_ACTION_ID_ASC`** **`FURTHER_ACTION_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionPartsConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPartsConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionPartsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionPartsEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPartsEdge A Relay edge containing a `FurtherActionParts` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherActionPart` The item at the end of the edge # FurtherActionPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionPartsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FurtherActionPartsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`furtherAction`**: `FurtherActionsInputFilters` --- **`furtherActionId`**: `IDFilter` --- **`or_`**: `[FurtherActionPartsInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # FurtherActionRun Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRun A further action run object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`furtherAction`**: `FurtherAction` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`furtherActionId`**: `Int!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `FurtherActionRunEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # FurtherActionRunEventFilter Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRunEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`furtherActionId`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`runId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # FurtherActionRunEvents Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRunEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `FurtherActionRun` --- **`oldValues`**: `FurtherActionRun` --- **`timestamp`**: `DateTime` # FurtherActionRunSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRunSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FURTHER_ACTION_ID_ASC`** **`FURTHER_ACTION_ID_DESC`** **`RUN_ID_ASC`** **`RUN_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionRunsConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRunsConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionRunsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionRunsEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRunsEdge A Relay edge containing a `FurtherActionRuns` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherActionRun` The item at the end of the edge # FurtherActionRunsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionRunsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[FurtherActionRunsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`furtherAction`**: `FurtherActionsInputFilters` --- **`furtherActionId`**: `IDFilter` --- **`or_`**: `[FurtherActionRunsInputFilters]` --- **`run`**: `RunsInputFilters` --- **`runId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # FurtherActionSettings Source: https://docs.firstresonance.io/api-reference/types/FurtherActionSettings Organization settings related to further actions. **Kind**: `object` ## Fields **`analysisNotesAlias`**: `String` --- **`attributes`**: `[AttributeSettings]` --- **`problemStatementAlias`**: `String` --- **`resolutionAlias`**: `String` # FurtherActionSettingsInput Source: https://docs.firstresonance.io/api-reference/types/FurtherActionSettingsInput Input settings related to further actions. **Kind**: `input` ## Fields **`analysisNotesAlias`**: `String` --- **`problemStatementAlias`**: `String` --- **`resolutionAlias`**: `String` # FurtherActionSortEnum Source: https://docs.firstresonance.io/api-reference/types/FurtherActionSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ESTIMATED_COMPLETION_DATE_ASC`** **`ESTIMATED_COMPLETION_DATE_DESC`** **`ID_ASC`** **`ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # FurtherActionStatus Source: https://docs.firstresonance.io/api-reference/types/FurtherActionStatus Enum of further action statuses. **Kind**: `enum` ## Values **`CANCELED`** **`IN_PROGRESS`** **`IN_REVIEW`** **`RESOLVED`** # FurtherActionsConnection Source: https://docs.firstresonance.io/api-reference/types/FurtherActionsConnection **Kind**: `object` ## Fields **`edges`**: `[FurtherActionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # FurtherActionsEdge Source: https://docs.firstresonance.io/api-reference/types/FurtherActionsEdge A Relay edge containing a `FurtherActions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `FurtherAction` The item at the end of the edge # FurtherActionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/FurtherActionsInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`analysisNotes`**: `SlateContentNullFilter` --- **`and_`**: `[FurtherActionsInputFilters]` --- **`approvalRequests`**: `FurtherActionApprovalRequestsInputFilters` --- **`approvals`**: `FurtherActionApprovalsInputFilters` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`attributedParts`**: `FurtherActionAttributedPartsInputFilters` --- **`attributedUsers`**: `FurtherActionAttributedUsersInputFilters` --- **`attributes`**: `FurtherActionAttributesInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`estimatedCompletionDate`**: `DateTimeFilter` --- **`id`**: `IDFilter` --- **`issues`**: `IssueInputFilters` --- **`labels`**: `LabelsInputFilters` --- **`or_`**: `[FurtherActionsInputFilters]` --- **`parts`**: `PartsInputFilters` --- **`problemStatement`**: `SlateContentNullFilter` --- **`resolution`**: `SlateContentNullFilter` --- **`runs`**: `RunsInputFilters` --- **`status`**: `FurtheractionstatusenumFilter` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Furtheractionapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Furtheractionapprovalgatetypeenum **Kind**: `enum` ## Values **`RESOLVED`** # FurtheractionapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/FurtheractionapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Furtheractionapprovalgatetypeenum` --- **`gt`**: `Furtheractionapprovalgatetypeenum` --- **`gte`**: `Furtheractionapprovalgatetypeenum` --- **`ilike`**: `Furtheractionapprovalgatetypeenum` --- **`in`**: `[Furtheractionapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Furtheractionapprovalgatetypeenum` --- **`lt`**: `Furtheractionapprovalgatetypeenum` --- **`lte`**: `Furtheractionapprovalgatetypeenum` --- **`neq`**: `Furtheractionapprovalgatetypeenum` --- **`notilike`**: `Furtheractionapprovalgatetypeenum` --- **`notlike`**: `Furtheractionapprovalgatetypeenum` # Furtheractionstatusenum Source: https://docs.firstresonance.io/api-reference/types/Furtheractionstatusenum **Kind**: `enum` ## Values **`CANCELED`** **`IN_PROGRESS`** **`IN_REVIEW`** **`RESOLVED`** # FurtheractionstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/FurtheractionstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Furtheractionstatusenum` --- **`gt`**: `Furtheractionstatusenum` --- **`gte`**: `Furtheractionstatusenum` --- **`ilike`**: `Furtheractionstatusenum` --- **`in`**: `[Furtheractionstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Furtheractionstatusenum` --- **`lt`**: `Furtheractionstatusenum` --- **`lte`**: `Furtheractionstatusenum` --- **`neq`**: `Furtheractionstatusenum` --- **`notilike`**: `Furtheractionstatusenum` --- **`notlike`**: `Furtheractionstatusenum` # GenerateProcedureExport Source: https://docs.firstresonance.io/api-reference/types/GenerateProcedureExport Kicks off a Procedure file export given a GenerateProcedureExportInput argument. **Kind**: `object` ## Fields **`message`**: `String` # GenerateProcedureExportInput Source: https://docs.firstresonance.io/api-reference/types/GenerateProcedureExportInput Inputs needed to export a Procedure's files. **Kind**: `input` ## Fields **`bundle`**: `Boolean` = false Include file attachments on the procedure and its steps. --- **`includeAssets`**: `Boolean` = false Include assets and PDFs on the procedure's steps. --- **`procedureIds`**: `[Int]!` (required) # GenerateReadEmbeddedAnalytics Source: https://docs.firstresonance.io/api-reference/types/GenerateReadEmbeddedAnalytics Create a Sigma signed url with "embedread" permissions. **Kind**: `object` ## Fields **`embeddedAnalytics`**: `EmbeddedAnalytics` # GenerateRunSummary Source: https://docs.firstresonance.io/api-reference/types/GenerateRunSummary Kicks off a Run summary export given a GenerateRunSummaryInput argument. **Kind**: `object` ## Fields **`message`**: `String` # GenerateRunSummaryInput Source: https://docs.firstresonance.io/api-reference/types/GenerateRunSummaryInput Inputs needed to generate Run summary. **Kind**: `input` ## Fields **`bundle`**: `Boolean` = false --- **`includeAssets`**: `Boolean` = false --- **`runIds`**: `[Int]!` (required) # GenerateWriteEmbeddedAnalytics Source: https://docs.firstresonance.io/api-reference/types/GenerateWriteEmbeddedAnalytics Create a Sigma signed url with "embedwrite" permissions. **Kind**: `object` ## Fields **`embeddedAnalytics`**: `EmbeddedAnalytics` # GetKitItemsImporterTemplateUrl Source: https://docs.firstresonance.io/api-reference/types/GetKitItemsImporterTemplateUrl Get download URL for kit items import CSV template. **Kind**: `object` ## Fields **`downloadUrl`**: `String!` # GetMBomImporterTemplateUrl Source: https://docs.firstresonance.io/api-reference/types/GetMBomImporterTemplateUrl Get download URL for mBOM Importer's CSV template. **Kind**: `object` ## Fields **`downloadUrl`**: `String!` # GlobalUniqueSerialNumber Source: https://docs.firstresonance.io/api-reference/types/GlobalUniqueSerialNumber Generate a global unique serial number. **Kind**: `object` ## Fields **`serialNumber`**: `String` # GlobalUniqueSerialNumberSchemeSettings Source: https://docs.firstresonance.io/api-reference/types/GlobalUniqueSerialNumberSchemeSettings Organization settings for part revision format and restrictions. **Kind**: `object` ## Fields **`default`**: `Boolean` --- **`enabled`**: `Boolean` --- **`exclude`**: `String` --- **`name`**: `String` --- **`serialScheme`**: `String` --- **`startAt`**: `Int` # IDFilter Source: https://docs.firstresonance.io/api-reference/types/IDFilter **Kind**: `input` ## Fields **`eq`**: `ID` --- **`gt`**: `ID` --- **`gte`**: `ID` --- **`ilike`**: `ID` --- **`in`**: `[ID]` --- **`isnull`**: `Boolean` --- **`like`**: `ID` --- **`lt`**: `ID` --- **`lte`**: `ID` --- **`neq`**: `ID` --- **`notilike`**: `ID` --- **`notlike`**: `ID` # ImportJob Source: https://docs.firstresonance.io/api-reference/types/ImportJob Import Job GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entityId`**: `Int!` --- **`errors`**: `JSONString!` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`filename`**: `String` --- **`id`**: `Int!` --- **`importDuration`**: `Int` --- **`importOptions`**: `JSONString!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`numRows`**: `Int` --- **`prettyStr`**: `String` --- **`status`**: `ImportJobStatus!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ImportJobEventFilter` --- **`type`**: `Importjobtypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ImportJobEventFilter Source: https://docs.firstresonance.io/api-reference/types/ImportJobEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`filename`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`numRows`**: `IntFilter` --- **`status`**: `ImportJobStatusFilter` --- **`type`**: `ImportjobtypeenumFilter` --- **`updatedById`**: `IDFilter` # ImportJobEvents Source: https://docs.firstresonance.io/api-reference/types/ImportJobEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ImportJob` --- **`oldValues`**: `ImportJob` --- **`timestamp`**: `DateTime` # ImportJobSortEnum Source: https://docs.firstresonance.io/api-reference/types/ImportJobSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FILENAME_ASC`** **`FILENAME_DESC`** **`ID_ASC`** **`ID_DESC`** **`NUM_ROWS_ASC`** **`NUM_ROWS_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ImportJobStatus Source: https://docs.firstresonance.io/api-reference/types/ImportJobStatus Enum of import job statuses. **Kind**: `enum` ## Values **`COMPLETED`** **`FAILED`** **`IN_PROGRESS`** **`PENDING`** # ImportJobStatusFilter Source: https://docs.firstresonance.io/api-reference/types/ImportJobStatusFilter **Kind**: `input` ## Fields **`eq`**: `ImportJobStatus` --- **`gt`**: `ImportJobStatus` --- **`gte`**: `ImportJobStatus` --- **`ilike`**: `ImportJobStatus` --- **`in`**: `[ImportJobStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `ImportJobStatus` --- **`lt`**: `ImportJobStatus` --- **`lte`**: `ImportJobStatus` --- **`neq`**: `ImportJobStatus` --- **`notilike`**: `ImportJobStatus` --- **`notlike`**: `ImportJobStatus` # ImportJobType Source: https://docs.firstresonance.io/api-reference/types/ImportJobType Enum of import job types. **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS`** **`ISSUES`** **`KIT_ITEMS`** **`LOCATIONS`** **`MBOMS`** **`MOCK`** **`PARTS`** **`PARTS_INVENTORY`** **`PART_PROCEDURE_RELATIONS`** **`PLAN_INPUTS`** **`PURCHASE_ORDERS`** **`PURCHASE_ORDER_LINES`** **`RUNS`** **`SUPPLIERS`** **`TOOLS`** **`TOOLS_INVENTORY`** # ImportJobsConnection Source: https://docs.firstresonance.io/api-reference/types/ImportJobsConnection **Kind**: `object` ## Fields **`edges`**: `[ImportJobsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ImportJobsEdge Source: https://docs.firstresonance.io/api-reference/types/ImportJobsEdge A Relay edge containing a `ImportJobs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ImportJob` The item at the end of the edge # ImportJobsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ImportJobsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ImportJobsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`filename`**: `StringFilter` --- **`id`**: `IDFilter` --- **`numRows`**: `IntFilter` --- **`or_`**: `[ImportJobsInputFilters]` --- **`status`**: `ImportJobStatusFilter` --- **`type`**: `ImportjobtypeenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ImportKitItems Source: https://docs.firstresonance.io/api-reference/types/ImportKitItems Import kit items from structured GraphQL inputs (multi-kit). **Kind**: `object` ## Fields **`createdPartKitItemIds`**: `[Int]!` --- **`errors`**: `[ImportKitItemsError]!` --- **`updatedKitIds`**: `[Int]!` --- **`updatedPartKitItemIds`**: `[Int]!` # ImportKitItemsCsv Source: https://docs.firstresonance.io/api-reference/types/ImportKitItemsCsv Import kit items from a CSV in S3. **Kind**: `object` ## Fields **`createdPartKitItemIds`**: `[Int]!` --- **`errors`**: `[ImportKitItemsError]!` --- **`updatedKitIds`**: `[Int]!` --- **`updatedPartKitItemIds`**: `[Int]!` # ImportKitItemsCsvInput Source: https://docs.firstresonance.io/api-reference/types/ImportKitItemsCsvInput Input for CSV-backed kit import (multi-kit). **Kind**: `input` ## Fields **`s3Etag`**: `String` --- **`s3Key`**: `String!` (required) # ImportKitItemsError Source: https://docs.firstresonance.io/api-reference/types/ImportKitItemsError Kit import error for a specific row/kit. **Kind**: `object` ## Fields **`message`**: `String!` --- **`row`**: `Int` # ImportKitItemsInput Source: https://docs.firstresonance.io/api-reference/types/ImportKitItemsInput Input for structured kit import (multi-kit). **Kind**: `input` ## Fields **`items`**: `[ImportKitItemsRowInput]!` (required) # ImportKitItemsRowInput Source: https://docs.firstresonance.io/api-reference/types/ImportKitItemsRowInput Single kit import row (structured input). **Kind**: `input` ## Fields **`kitId`**: `Int!` (required) --- **`partNumber`**: `String!` (required) --- **`quantity`**: `ScalarValue!` (required) --- **`revision`**: `String` # ImportStepsFromPDF Source: https://docs.firstresonance.io/api-reference/types/ImportStepsFromPDF Import a step from a PDF. **Kind**: `object` ## Fields **`steps`**: `[Step]` # ImportStepsFromPDFInput Source: https://docs.firstresonance.io/api-reference/types/ImportStepsFromPDFInput Inputs needed to create a step from a PDF. **Kind**: `input` ## Fields **`parseContent`**: `Boolean` = false --- **`pdfAssetId`**: `ID!` (required) --- **`procedureId`**: `ID!` (required) --- **`stepPages`**: `[StepPagesInput]` # Importjobtypeenum Source: https://docs.firstresonance.io/api-reference/types/Importjobtypeenum **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS`** **`ISSUES`** **`KIT_ITEMS`** **`LOCATIONS`** **`MBOMS`** **`MOCK`** **`PARTS`** **`PARTS_INVENTORY`** **`PART_PROCEDURE_RELATIONS`** **`PLAN_INPUTS`** **`PURCHASE_ORDERS`** **`PURCHASE_ORDER_LINES`** **`RUNS`** **`SUPPLIERS`** **`TOOLS`** **`TOOLS_INVENTORY`** # ImportjobtypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/ImportjobtypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Importjobtypeenum` --- **`gt`**: `Importjobtypeenum` --- **`gte`**: `Importjobtypeenum` --- **`ilike`**: `Importjobtypeenum` --- **`in`**: `[Importjobtypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Importjobtypeenum` --- **`lt`**: `Importjobtypeenum` --- **`lte`**: `Importjobtypeenum` --- **`neq`**: `Importjobtypeenum` --- **`notilike`**: `Importjobtypeenum` --- **`notlike`**: `Importjobtypeenum` # InstallKitOnABom Source: https://docs.firstresonance.io/api-reference/types/InstallKitOnABom Installs kit on aBOM mutation. Installs all parts from a given kit onto an aBOM. **Kind**: `object` ## Fields **`abomInstallations`**: `[ABomInstallation]` # InstallKitOnABomInput Source: https://docs.firstresonance.io/api-reference/types/InstallKitOnABomInput Inputs needed to install from kit on inventory. **Kind**: `input` ## Fields **`actingParentPartInventoryId`**: `Int` --- **`etag`**: `String!` (required) --- **`partInventoryId`**: `Int!` (required) --- **`partKitId`**: `Int!` (required) --- **`runStepId`**: `Int` # IntFilter Source: https://docs.firstresonance.io/api-reference/types/IntFilter **Kind**: `input` ## Fields **`eq`**: `Int` --- **`gt`**: `Int` --- **`gte`**: `Int` --- **`ilike`**: `Int` --- **`in`**: `[Int]` --- **`isnull`**: `Boolean` --- **`like`**: `Int` --- **`lt`**: `Int` --- **`lte`**: `Int` --- **`neq`**: `Int` --- **`notilike`**: `Int` --- **`notlike`**: `Int` # IntentOption Source: https://docs.firstresonance.io/api-reference/types/IntentOption The Object Type for Intent Options. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_IssueDispositionTypesCount`**: `Int` Optimized count of issueDispositionTypes. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`isReceivingInspectionRunRequired`**: `Boolean` --- **`issueDispositionTypes`**: `[IssueDispositionType]` **Arguments:** - `filters`: `IssueDispositionTypesInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`rank`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IntentOptionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String` # IntentOptionEventFilter Source: https://docs.firstresonance.io/api-reference/types/IntentOptionEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isReceivingInspectionRunRequired`**: `BooleanFilter` --- **`rank`**: `IntFilter` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # IntentOptionEvents Source: https://docs.firstresonance.io/api-reference/types/IntentOptionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IntentOption` --- **`oldValues`**: `IntentOption` --- **`timestamp`**: `DateTime` # IntentOptionSortEnum Source: https://docs.firstresonance.io/api-reference/types/IntentOptionSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_RECEIVING_INSPECTION_RUN_REQUIRED_ASC`** **`IS_RECEIVING_INSPECTION_RUN_REQUIRED_DESC`** **`RANK_ASC`** **`RANK_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IntentOptionsConnection Source: https://docs.firstresonance.io/api-reference/types/IntentOptionsConnection **Kind**: `object` ## Fields **`edges`**: `[IntentOptionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IntentOptionsEdge Source: https://docs.firstresonance.io/api-reference/types/IntentOptionsEdge A Relay edge containing a `IntentOptions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IntentOption` The item at the end of the edge # IntentOptionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/IntentOptionsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IntentOptionsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`isReceivingInspectionRunRequired`**: `BooleanFilter` --- **`issueDispositionTypes`**: `IssueDispositionTypesInputFilters` --- **`or_`**: `[IntentOptionsInputFilters]` --- **`rank`**: `IntFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # IntentSettings Source: https://docs.firstresonance.io/api-reference/types/IntentSettings Organization settings related to intent. **Kind**: `object` ## Fields **`alias`**: `String` --- **`downgradeOnInstall`**: `SimplePolicySettings` --- **`issueIntentUpdate`**: `IssueIntentUpdateSettings` --- **`partQualityCheck`**: `PartQualityCheckSettings` --- **`poLineSideEffect`**: `SimplePolicySettings` --- **`requireInstallIntentMatch`**: `RequireInstallIntentMatchSettings` --- **`requireKitIntentMatch`**: `RequireKitIntentMatchSettings` --- **`requiredAtManualInventoryCreate`**: `SimplePolicySettings` --- **`requiredAtRunCreate`**: `RequiredAtRunCreateSettings` --- **`requiredAtRunStepStart`**: `RequiredAtRunStepStartSettings` --- **`requiredOnRunIntentUpdate`**: `RequiredOnRunIntentUpdateSettings` --- **`runIntentSideEffect`**: `RunIntentSideEffectSettings` # IntentSettingsInput Source: https://docs.firstresonance.io/api-reference/types/IntentSettingsInput Input settings related to intent. **Kind**: `input` ## Fields **`alias`**: `String` --- **`downgradeOnInstall`**: `SimplePolicySettingsInput` --- **`issueIntentUpdate`**: `IssueIntentUpdateSettingsInput` --- **`partQualityCheck`**: `PartQualityCheckSettingsInput` --- **`poLineSideEffect`**: `SimplePolicySettingsInput` --- **`requireInstallIntentMatch`**: `RequireInstallIntentMatchSettingsInput` --- **`requireKitIntentMatch`**: `RequireKitIntentMatchSettingsInput` --- **`requiredAtManualInventoryCreate`**: `SimplePolicySettingsInput` --- **`requiredAtRunCreate`**: `RequiredAtRunCreateSettingsInput` --- **`requiredAtRunStepStart`**: `RequiredAtRunStepStartSettingsInput` --- **`requiredOnRunIntentUpdate`**: `RequiredOnRunIntentUpdateSettingsInput` --- **`runIntentSideEffect`**: `RunIntentSideEffectSettingsInput` # IntercomIntegration Source: https://docs.firstresonance.io/api-reference/types/IntercomIntegration Segment Integration data. Note: Segment has several integrated widgets that we use, including Intercom. The user_hash field below is used to identify the user in Intercom. **Kind**: `object` ## Fields **`userHash`**: `String` # InventoryEventType Source: https://docs.firstresonance.io/api-reference/types/InventoryEventType Inventory event type enum. **Kind**: `enum` ## Values **`DIRECT_SPLIT`** **`MANUAL`** **`MERGE`** **`MOA_MADE`** **`PARTIAL_ASSIGN_TO_ISSUE`** **`PARTIAL_INSTALL`** **`PARTIAL_KIT`** **`PARTIAL_RECEIVE`** **`PARTIAL_SCRAP`** **`PARTIAL_UNINSTALL`** **`PARTIAL_UNKIT`** **`PARTIAL_UNSCRAP`** **`PO_LINE_MADE`** **`RUN_MADE`** **`UNKNOWN`** # InventoryEventTypeFilter Source: https://docs.firstresonance.io/api-reference/types/InventoryEventTypeFilter **Kind**: `input` ## Fields **`eq`**: `InventoryEventType` --- **`gt`**: `InventoryEventType` --- **`gte`**: `InventoryEventType` --- **`ilike`**: `InventoryEventType` --- **`in`**: `[InventoryEventType]` --- **`isnull`**: `Boolean` --- **`like`**: `InventoryEventType` --- **`lt`**: `InventoryEventType` --- **`lte`**: `InventoryEventType` --- **`neq`**: `InventoryEventType` --- **`notilike`**: `InventoryEventType` --- **`notlike`**: `InventoryEventType` # InventoryReviewResolution Source: https://docs.firstresonance.io/api-reference/types/InventoryReviewResolution Human dispositions for inventory awaiting review. **Kind**: `enum` ## Values **`DELETE`** **`RELEASE`** **`SCRAP`** # InventoryStatus Source: https://docs.firstresonance.io/api-reference/types/InventoryStatus Enum for inventory statuses. **Kind**: `enum` ## Values **`AVAILABLE`** **`INSTALLED`** **`KITTED`** **`NEEDS_REVIEW`** **`ON_ORDER`** **`SCRAPPED`** **`UNAVAILABLE`** **`WIP`** # InventoryStatusFilter Source: https://docs.firstresonance.io/api-reference/types/InventoryStatusFilter **Kind**: `input` ## Fields **`eq`**: `InventoryStatus` --- **`gt`**: `InventoryStatus` --- **`gte`**: `InventoryStatus` --- **`ilike`**: `InventoryStatus` --- **`in`**: `[InventoryStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `InventoryStatus` --- **`lt`**: `InventoryStatus` --- **`lte`**: `InventoryStatus` --- **`neq`**: `InventoryStatus` --- **`notilike`**: `InventoryStatus` --- **`notlike`**: `InventoryStatus` # InventoryToKitInput Source: https://docs.firstresonance.io/api-reference/types/InventoryToKitInput Input needed to issue item to kit or move item to inventory. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`partInventoryId`**: `ID!` (required) --- **`partKitItemId`**: `ID!` (required) --- **`quantity`**: `Float` = 1 # Invite Source: https://docs.firstresonance.io/api-reference/types/Invite An invitation delivered via email to join an organization in the Ion platform. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`auth0InvitationId`**: `String` --- **`auth0OrgId`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`email`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`message`**: `String` --- **`name`**: `String` --- **`prettyStr`**: `String` --- **`resendCount`**: `Int` --- **`status`**: `InvitesStatusEnum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `InviteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # InviteEventFilter Source: https://docs.firstresonance.io/api-reference/types/InviteEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`auth0InvitationId`**: `StringFilter` --- **`auth0OrgId`**: `StringFilter` --- **`createdById`**: `IDFilter` --- **`email`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`message`**: `StringFilter` --- **`name`**: `StringFilter` --- **`resendCount`**: `IntFilter` --- **`status`**: `InvitesStatusEnumFilter` --- **`updatedById`**: `IDFilter` # InviteEvents Source: https://docs.firstresonance.io/api-reference/types/InviteEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Invite` --- **`oldValues`**: `Invite` --- **`timestamp`**: `DateTime` # InviteOrganizationMember Source: https://docs.firstresonance.io/api-reference/types/InviteOrganizationMember Send an Auth0 Organization invitation to a new member. **Kind**: `object` ## Fields **`invitationId`**: `String` --- **`success`**: `Boolean` # InviteOrganizationMemberInput Source: https://docs.firstresonance.io/api-reference/types/InviteOrganizationMemberInput **Kind**: `input` ## Fields **`auth0OrgId`**: `String!` (required) --- **`inviteeEmail`**: `String!` (required) # InviteSortEnum Source: https://docs.firstresonance.io/api-reference/types/InviteSortEnum **Kind**: `enum` ## Values **`AUTH0_INVITATION_ID_ASC`** **`AUTH0_INVITATION_ID_DESC`** **`AUTH0_ORG_ID_ASC`** **`AUTH0_ORG_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`EMAIL_ASC`** **`EMAIL_DESC`** **`ID_ASC`** **`ID_DESC`** **`MESSAGE_ASC`** **`MESSAGE_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`RESEND_COUNT_ASC`** **`RESEND_COUNT_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # InvitesConnection Source: https://docs.firstresonance.io/api-reference/types/InvitesConnection **Kind**: `object` ## Fields **`edges`**: `[InvitesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # InvitesEdge Source: https://docs.firstresonance.io/api-reference/types/InvitesEdge A Relay edge containing a `Invites` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Invite` The item at the end of the edge # InvitesInputFilters Source: https://docs.firstresonance.io/api-reference/types/InvitesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[InvitesInputFilters]` --- **`auth0InvitationId`**: `StringFilter` --- **`auth0OrgId`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`email`**: `StringFilter` --- **`id`**: `IDFilter` --- **`message`**: `StringFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[InvitesInputFilters]` --- **`resendCount`**: `IntFilter` --- **`status`**: `InvitesStatusEnumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # InvitesStatusEnum Source: https://docs.firstresonance.io/api-reference/types/InvitesStatusEnum **Kind**: `enum` ## Values **`COMPLETE`** **`PENDING`** **`REVOKED`** # InvitesStatusEnumFilter Source: https://docs.firstresonance.io/api-reference/types/InvitesStatusEnumFilter **Kind**: `input` ## Fields **`eq`**: `InvitesStatusEnum` --- **`gt`**: `InvitesStatusEnum` --- **`gte`**: `InvitesStatusEnum` --- **`ilike`**: `InvitesStatusEnum` --- **`in`**: `[InvitesStatusEnum]` --- **`isnull`**: `Boolean` --- **`like`**: `InvitesStatusEnum` --- **`lt`**: `InvitesStatusEnum` --- **`lte`**: `InvitesStatusEnum` --- **`neq`**: `InvitesStatusEnum` --- **`notilike`**: `InvitesStatusEnum` --- **`notlike`**: `InvitesStatusEnum` # IonPageInfo Source: https://docs.firstresonance.io/api-reference/types/IonPageInfo The Relay compliant `IonPageInfo` type, containing data necessary to paginate this connection. **Kind**: `object` ## Fields **`count`**: `Int!` Count of paginated objects returned --- **`endCursor`**: `String` When paginating forwards, the cursor to continue. --- **`hasNextPage`**: `Boolean!` When paginating forwards, are there more items? --- **`hasPreviousPage`**: `Boolean!` When paginating backwards, are there more items? --- **`startCursor`**: `String` When paginating backwards, the cursor to continue. --- **`totalCount`**: `Int!` Total count of query objects available # IonType Source: https://docs.firstresonance.io/api-reference/types/IonType The union of types which can be linked via extensible attributes. **Kind**: `union` ## Possible types - `Location` - `Part` - `Project` - `User` # IonTypeFilterInput Source: https://docs.firstresonance.io/api-reference/types/IonTypeFilterInput IonType filterable fields. **Kind**: `input` ## Fields **`location`**: `LocationsInputFilters` --- **`part`**: `PartsInputFilters` --- **`project`**: `ProjectsInputFilters` --- **`user`**: `UserInputFilters` # Issue Source: https://docs.firstresonance.io/api-reference/types/Issue The graphene sqlalchemy object type for issues. **Kind**: `object` ## Fields **`Attributes`**: `[IssueAttribute]` **Arguments:** - `filters`: `IssueAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FurtherActionsCount`**: `Int` Optimized count of furtherActions. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_OriginIssuesCount`**: `Int` Optimized count of originIssues. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_RedlinesCount`**: `Int` Optimized count of redlines. --- **`_RelatedIssuesCount`**: `Int` --- **`_SiblingIssuesCount`**: `Int` Optimized count of siblingIssues. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[IssueApprovalRequest]` **Arguments:** - `filters`: `IssueApprovalRequestsInputFilters` --- **`approvals`**: `[IssueApproval]` **Arguments:** - `filters`: `IssueApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[IssueAttributedPart]` **Arguments:** - `filters`: `IssueAttributedPartsInputFilters` --- **`attributedUsers`**: `[IssueAttributedUser]` **Arguments:** - `filters`: `IssueAttributedUsersInputFilters` --- **`attributes`**: `[IssueAttribute]` --- **`batchSiblings`**: `[Issue]` --- **`batched`**: `String` --- **`causeCondition`**: `SlateContent` --- **`comments`**: `[Comment]` --- **`createIssueForEachBatchSibling`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`disposition`**: `SlateContent` --- **`editable`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`expectedCondition`**: `SlateContent` --- **`fileAttachments`**: `[FileAttachment]` --- **`fixPartInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`fixPartInventoryId`**: `Int` --- **`furtherActions`**: `[FurtherAction]` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`id`**: `Int!` --- **`issueDispositionType`**: `IssueDispositionType` **Arguments:** - `filters`: `IssueDispositionTypesInputFilters` --- **`issueDispositionTypeId`**: `Int` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mustCloseByRunStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`mustCloseByRunStepId`**: `Int` --- **`originIssues`**: `[Issue]` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventory`**: `PartInventory` Get first part inventory tied to issue. To get all part inventories please use the partInventories field. This field is now deprecated. > Deprecated: Issues can now have multiple part inventories tied to them. --- **`partInventoryId`**: `Int` Part inventory id. > Deprecated: Issues can now have multiple part inventories tied to them. --- **`prettyStr`**: `String` --- **`purchaseOrderLine`**: `PurchaseOrderLine` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `Int` --- **`redlines`**: `[Redline]` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`relatedIssues`**: `[Issue]` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`siblingIssues`**: `[Issue]` --- **`status`**: `Issuestatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueEventFilter` --- **`title`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # IssueApproval Source: https://docs.firstresonance.io/api-reference/types/IssueApproval An approval related to an issue. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`issueId`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `IssueApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[IssueApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # IssueApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `IssueapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueId`**: `IDFilter` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # IssueApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssueApproval` --- **`oldValues`**: `IssueApproval` --- **`timestamp`**: `DateTime` # IssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequest A request to approve an issue. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`issueId`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # IssueApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `IssueapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # IssueApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssueApprovalRequest` --- **`oldValues`**: `IssueApprovalRequest` --- **`timestamp`**: `DateTime` # IssueApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`ISSUE_ID_ASC`** **`ISSUE_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IssueApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[IssueApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssueApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequestsEdge A Relay edge containing a `IssueApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IssueApprovalRequest` The item at the end of the edge # IssueApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalRequestsInputFilters IssueApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IssueApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`issue`**: `IssueInputFilters` --- **`issueApprovalGateType`**: `IssueapprovalgatetypeenumFilter` --- **`issueId`**: `IDFilter` --- **`or_`**: `[IssueApprovalRequestsInputFilters]` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssueApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`ISSUE_ID_ASC`** **`ISSUE_ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IssueApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[IssueApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssueApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalsEdge A Relay edge containing a `IssueApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IssueApproval` The item at the end of the edge # IssueApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueApprovalsInputFilters IssueApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IssueApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`issue`**: `IssueInputFilters` --- **`issueApprovalGateType`**: `IssueapprovalgatetypeenumFilter` --- **`issueId`**: `IDFilter` --- **`or_`**: `[IssueApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssueAttribute Source: https://docs.firstresonance.io/api-reference/types/IssueAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueId`**: `Int` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # IssueAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # IssueAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/IssueAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssueAttribute` --- **`oldValues`**: `IssueAttribute` --- **`timestamp`**: `DateTime` # IssueAttributedPart Source: https://docs.firstresonance.io/api-reference/types/IssueAttributedPart Auto-generated GQL type for IssueAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # IssueAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[IssueAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[IssueAttributedPartsInputFilters]` # IssueAttributedUser Source: https://docs.firstresonance.io/api-reference/types/IssueAttributedUser Auto-generated GQL type for IssueAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # IssueAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[IssueAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[IssueAttributedUsersInputFilters]` # IssueAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[IssueAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`issue`**: `IssueInputFilters` --- **`issueId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[IssueAttributesInputFilters]` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # IssueDispositionType Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionType The graphene sqlalchemy object type for issue disposition type. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_IssueDispositionTypeRolesCount`**: `Int` Optimized count of issueDispositionTypeRoles. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_RolesCount`**: `Int` Optimized count of roles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`active`**: `Boolean!` --- **`autoResolve`**: `Boolean!` --- **`availabilityBehavior`**: `IssueDispositionTypeAvailabilityBehavior` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` --- **`issueDispositionTypeRoles`**: `[IssueDispositionTypeRole]` **Arguments:** - `filters`: `IssueDispositionTypeRolesInputFilters` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueDispositionTypeEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id # IssueDispositionTypeAvailabilityBehavior Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeAvailabilityBehavior Enum of issue disposition type availability behaviors. **Kind**: `enum` ## Values **`AVAILABLE_IMMEDIATELY`** **`PERMANENTLY_UNAVAILABLE`** **`RELEASE_ON_RESOLVE`** # IssueDispositionTypeAvailabilityBehaviorFilter Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeAvailabilityBehaviorFilter **Kind**: `input` ## Fields **`eq`**: `IssueDispositionTypeAvailabilityBehavior` --- **`gt`**: `IssueDispositionTypeAvailabilityBehavior` --- **`gte`**: `IssueDispositionTypeAvailabilityBehavior` --- **`ilike`**: `IssueDispositionTypeAvailabilityBehavior` --- **`in`**: `[IssueDispositionTypeAvailabilityBehavior]` --- **`isnull`**: `Boolean` --- **`like`**: `IssueDispositionTypeAvailabilityBehavior` --- **`lt`**: `IssueDispositionTypeAvailabilityBehavior` --- **`lte`**: `IssueDispositionTypeAvailabilityBehavior` --- **`neq`**: `IssueDispositionTypeAvailabilityBehavior` --- **`notilike`**: `IssueDispositionTypeAvailabilityBehavior` --- **`notlike`**: `IssueDispositionTypeAvailabilityBehavior` # IssueDispositionTypeEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`active`**: `BooleanFilter` --- **`actor`**: `UserInputFilters` --- **`autoResolve`**: `BooleanFilter` --- **`availabilityBehavior`**: `IssueDispositionTypeAvailabilityBehaviorFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IDFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # IssueDispositionTypeEvents Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssueDispositionType` --- **`oldValues`**: `IssueDispositionType` --- **`timestamp`**: `DateTime` # IssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRole The graphene sqlalchemy object type for issue disposition type role. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`issueDispositionType`**: `IssueDispositionType` **Arguments:** - `filters`: `IssueDispositionTypesInputFilters` --- **`issueDispositionTypeId`**: `Int` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueDispositionTypeRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id # IssueDispositionTypeRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `IssueapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueDispositionTypeId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # IssueDispositionTypeRoleEvents Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssueDispositionTypeRole` --- **`oldValues`**: `IssueDispositionTypeRole` --- **`timestamp`**: `DateTime` # IssueDispositionTypeRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ISSUE_DISPOSITION_TYPE_ID_ASC`** **`ISSUE_DISPOSITION_TYPE_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IssueDispositionTypeRolesConnection Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRolesConnection **Kind**: `object` ## Fields **`edges`**: `[IssueDispositionTypeRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssueDispositionTypeRolesEdge Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRolesEdge A Relay edge containing a `IssueDispositionTypeRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IssueDispositionTypeRole` The item at the end of the edge # IssueDispositionTypeRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeRolesInputFilters IssueDispositionTypeRoles filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IssueDispositionTypeRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`issueApprovalGateType`**: `IssueapprovalgatetypeenumFilter` --- **`issueDispositionType`**: `IssueDispositionTypesInputFilters` --- **`issueDispositionTypeId`**: `IDFilter` --- **`or_`**: `[IssueDispositionTypeRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssueDispositionTypeSortEnum Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypeSortEnum **Kind**: `enum` ## Values **`ACTIVE_ASC`** **`ACTIVE_DESC`** **`AUTO_RESOLVE_ASC`** **`AUTO_RESOLVE_DESC`** **`AVAILABILITY_BEHAVIOR_ASC`** **`AVAILABILITY_BEHAVIOR_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IssueDispositionTypesConnection Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypesConnection **Kind**: `object` ## Fields **`edges`**: `[IssueDispositionTypesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssueDispositionTypesEdge Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypesEdge A Relay edge containing a `IssueDispositionTypes` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IssueDispositionType` The item at the end of the edge # IssueDispositionTypesInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueDispositionTypesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`active`**: `BooleanFilter` --- **`and_`**: `[IssueDispositionTypesInputFilters]` --- **`autoResolve`**: `BooleanFilter` --- **`availabilityBehavior`**: `IssueDispositionTypeAvailabilityBehaviorFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`id`**: `IDFilter` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IDFilter` --- **`issueDispositionTypeRoles`**: `IssueDispositionTypeRolesInputFilters` --- **`issues`**: `IssueInputFilters` --- **`or_`**: `[IssueDispositionTypesInputFilters]` --- **`roles`**: `RolesInputFilters` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssueEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fixPartInventoryId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueDispositionTypeId`**: `IDFilter` --- **`mustCloseByRunStepId`**: `IDFilter` --- **`partInventoryId`**: `IntFilter` --- **`purchaseOrderLineId`**: `IDFilter` --- **`runStepId`**: `IDFilter` --- **`status`**: `IssuestatusenumFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # IssueEvents Source: https://docs.firstresonance.io/api-reference/types/IssueEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Issue` --- **`oldValues`**: `Issue` --- **`timestamp`**: `DateTime` # IssueInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueInputFilters Issue filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IssueInputFilters]` --- **`approvalRequests`**: `IssueApprovalRequestsInputFilters` --- **`approvals`**: `IssueApprovalsInputFilters` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`attributedParts`**: `IssueAttributedPartsInputFilters` --- **`attributedUsers`**: `IssueAttributedUsersInputFilters` --- **`attributes`**: `IssueAttributesInputFilters` --- **`comments`**: `CommentsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`fixPartInventory`**: `PartInventoriesInputFilters` --- **`fixPartInventoryId`**: `IDFilter` --- **`furtherActions`**: `FurtherActionsInputFilters` --- **`id`**: `IDFilter` --- **`issueDispositionType`**: `IssueDispositionTypesInputFilters` --- **`issueDispositionTypeId`**: `IDFilter` --- **`labels`**: `LabelsInputFilters` --- **`mustCloseByRunStep`**: `RunStepsInputFilters` --- **`mustCloseByRunStepId`**: `IDFilter` --- **`or_`**: `[IssueInputFilters]` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IntFilter` --- **`purchaseOrderLine`**: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `IDFilter` --- **`redlines`**: `RedlinesInputFilters` --- **`relatedIssues`**: `IssueInputFilters` --- **`runId`**: `IDFilter` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepId`**: `IDFilter` --- **`status`**: `IssuestatusenumFilter` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssueIntentUpdateSettings Source: https://docs.firstresonance.io/api-reference/types/IssueIntentUpdateSettings Settings for issue_intent_update policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` # IssueIntentUpdateSettingsInput Source: https://docs.firstresonance.io/api-reference/types/IssueIntentUpdateSettingsInput Input for issue_intent_update policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` # IssueItemToKit Source: https://docs.firstresonance.io/api-reference/types/IssueItemToKit Issues an item to a PartKitItem given its inventory and part kit item ids. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` --- **`splitInventory`**: `PartInventory` # IssuePartInventoriesConnection Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventoriesConnection **Kind**: `object` ## Fields **`edges`**: `[IssuePartInventoriesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssuePartInventoriesEdge Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventoriesEdge A Relay edge containing a `IssuePartInventories` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IssuePartInventory` The item at the end of the edge # IssuePartInventoriesInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventoriesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IssuePartInventoriesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`fromSplitInventory`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`issue`**: `IssueInputFilters` --- **`issueId`**: `IDFilter` --- **`or_`**: `[IssuePartInventoriesInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssuePartInventory Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventory The graphene sqlalchemy object type for. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`fromSplitInventory`**: `Boolean!` --- **`id`**: `ID` --- **`issue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`issueId`**: `Int` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssuePartInventoryEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id # IssuePartInventoryEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventoryEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fromSplitInventory`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`issueId`**: `IDFilter` --- **`partInventoryId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # IssuePartInventoryEvents Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventoryEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssuePartInventory` --- **`oldValues`**: `IssuePartInventory` --- **`timestamp`**: `DateTime` # IssuePartInventorySortEnum Source: https://docs.firstresonance.io/api-reference/types/IssuePartInventorySortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FROM_SPLIT_INVENTORY_ASC`** **`FROM_SPLIT_INVENTORY_DESC`** **`ID_ASC`** **`ID_DESC`** **`ISSUE_ID_ASC`** **`ISSUE_ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IssueRelation Source: https://docs.firstresonance.io/api-reference/types/IssueRelation The graphene sqlalchemy object type for issue relations. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`originIssue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`originIssueId`**: `Int!` --- **`prettyStr`**: `String` --- **`relatedIssue`**: `Issue` **Arguments:** - `filters`: `IssueInputFilters` --- **`relatedIssueId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `IssueRelationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # IssueRelationEventFilter Source: https://docs.firstresonance.io/api-reference/types/IssueRelationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`originIssueId`**: `IDFilter` --- **`relatedIssueId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # IssueRelationEvents Source: https://docs.firstresonance.io/api-reference/types/IssueRelationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `IssueRelation` --- **`oldValues`**: `IssueRelation` --- **`timestamp`**: `DateTime` # IssueRelationSortEnum Source: https://docs.firstresonance.io/api-reference/types/IssueRelationSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ORIGIN_ISSUE_ID_ASC`** **`ORIGIN_ISSUE_ID_DESC`** **`RELATED_ISSUE_ID_ASC`** **`RELATED_ISSUE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # IssueRelationsConnection Source: https://docs.firstresonance.io/api-reference/types/IssueRelationsConnection **Kind**: `object` ## Fields **`edges`**: `[IssueRelationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssueRelationsEdge Source: https://docs.firstresonance.io/api-reference/types/IssueRelationsEdge A Relay edge containing a `IssueRelations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `IssueRelation` The item at the end of the edge # IssueRelationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/IssueRelationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[IssueRelationsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`or_`**: `[IssueRelationsInputFilters]` --- **`originIssue`**: `IssueInputFilters` --- **`originIssueId`**: `IDFilter` --- **`relatedIssue`**: `IssueInputFilters` --- **`relatedIssueId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # IssueSettings Source: https://docs.firstresonance.io/api-reference/types/IssueSettings Settings related to issues. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`causeConditionAlias`**: `String` --- **`createIssueOnStepFailure`**: `Boolean` --- **`defaultAvailabilityBehavior`**: `IssueDispositionTypeAvailabilityBehavior` --- **`dispositionAlias`**: `String` --- **`enforceIssuesResolvedBeforeStepContinuation`**: `Boolean` --- **`expectedConditionAlias`**: `String` --- **`numApproversRequired`**: `Int` # IssueSettingsInput Source: https://docs.firstresonance.io/api-reference/types/IssueSettingsInput Input settings related to issues. **Kind**: `input` ## Fields **`causeConditionAlias`**: `String` --- **`createIssueOnStepFailure`**: `Boolean` --- **`defaultAvailabilityBehavior`**: `IssueDispositionTypeAvailabilityBehavior` --- **`dispositionAlias`**: `String` --- **`enforceIssuesResolvedBeforeStepContinuation`**: `Boolean` --- **`expectedConditionAlias`**: `String` --- **`numApproversRequired`**: `Int` # IssueSortEnum Source: https://docs.firstresonance.io/api-reference/types/IssueSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FIX_PART_INVENTORY_ID_ASC`** **`FIX_PART_INVENTORY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`ISSUE_DISPOSITION_TYPE_ID_ASC`** **`ISSUE_DISPOSITION_TYPE_ID_DESC`** **`MUST_CLOSE_BY_RUN_STEP_ID_ASC`** **`MUST_CLOSE_BY_RUN_STEP_ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PURCHASE_ORDER_LINE_ID_ASC`** **`PURCHASE_ORDER_LINE_ID_DESC`** **`RUN_STEP_ID_ASC`** **`RUN_STEP_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # Issueapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Issueapprovalgatetypeenum **Kind**: `enum` ## Values **`IN_PROGRESS`** **`RESOLVED`** # IssueapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/IssueapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Issueapprovalgatetypeenum` --- **`gt`**: `Issueapprovalgatetypeenum` --- **`gte`**: `Issueapprovalgatetypeenum` --- **`ilike`**: `Issueapprovalgatetypeenum` --- **`in`**: `[Issueapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Issueapprovalgatetypeenum` --- **`lt`**: `Issueapprovalgatetypeenum` --- **`lte`**: `Issueapprovalgatetypeenum` --- **`neq`**: `Issueapprovalgatetypeenum` --- **`notilike`**: `Issueapprovalgatetypeenum` --- **`notlike`**: `Issueapprovalgatetypeenum` # IssuedPartInventory Source: https://docs.firstresonance.io/api-reference/types/IssuedPartInventory Part Inventory attached to part kit with added field for issued quantity. **Kind**: `object` ## Fields **`Attributes`**: `[PartInventoryAttribute]` **Arguments:** - `filters`: `PartInventoryAttributesInputFilters` --- **`Cost`**: `Float` --- **`LastSessionId`**: `String` --- **`QuantityKitted`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_InstalledOnBuildRequirementCount`**: `Int` Optimized count of installedOnBuildRequirement. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MadeOnAssemblyChildPartInventoriesCount`**: `Int` Optimized count of madeOnAssemblyChildPartInventories. --- **`_MbomChangesCount`**: `Int` Optimized count of mbomChanges. --- **`_OriginRunsCount`**: `Int` Optimized count of originRuns. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of partKitInventories. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_PartKitsCount`**: `Int` --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_ReceiptsCount`**: `Int` Optimized count of receipts. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `Int!` --- **`activeKitId`**: `Int` The most recent active kit that the part inventory is in. --- **`attributedParts`**: `[PartInventoryAttributedPart]` **Arguments:** - `filters`: `PartInventoryAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartInventoryAttributedUser]` **Arguments:** - `filters`: `PartInventoryAttributedUsersInputFilters` --- **`attributes`**: `[PartInventoryAttribute]` --- **`awaitingReview`**: `Boolean!` True while this inventory awaits human review; status derives to needs_review until a review resolution or lifecycle event clears it. --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`canceledPoLinesCount`**: `Int!` --- **`comments`**: `[Comment]` **Arguments:** - `filters`: `CommentsInputFilters` --- **`cost`**: `Float` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrival`**: `DateTime` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`estimatedTotalCost`**: `Float` --- **`failedRunsCount`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`howCreated`**: `InventoryEventType` --- **`howLastSplit`**: `InventoryEventType` --- **`id`**: `Int!` --- **`identifiable`**: `Boolean` True if the inventory has a serial number, lot number, or location. This is used to determine if an inventory can be deleted when used on a purchase order line and the line is canceled. --- **`identity`**: `String` --- **`installed`**: `Boolean` True if the inventory's full quantity is installed onto a parent part. --- **`installedOnBuildRequirement`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`installedPartInventories`**: `[PartInventory]` --- **`installs`**: `[ABomInstallation]` --- **`intentOption`**: `IntentOption` Define intent option relationship. **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isLinkedToOspPoLine`**: `Boolean` True if this inventory is linked to a PO line via an outside processing (OSP) run step: the linking record has a run step set and that run step is marked as outside processing. Used to allow kitting of WIP inventory for OSP. --- **`isLocationAvailable`**: `Boolean!` --- **`issuedQuantity`**: `Float` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`kitted`**: `Boolean` True if the inventory's full quantity is actively kitted. --- **`labels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`lastMaintainedDate`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`lotNumber`**: `String` --- **`madeOnAssemblyChildPartInventories`**: `[PartInventory]` --- **`madeOnAssemblyParentPartInventory`**: `PartInventory` --- **`madeOnAssemblyParentPartInventoryId`**: `Int` --- **`maintenanceStatus`**: `MaintenanceStatus` --- **`mbomChanges`**: `[MbomChangeOrderLine]` **Arguments:** - `filters`: `MbomChangeOrderLinesInputFilters` --- **`mergeCandidateIds`**: `[Int]` --- **`mergeCandidateIdsV2`**: `[Int]` --- **`needDate`**: `DateTime` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`openPoLinesCount`**: `Int!` --- **`openRunsCount`**: `Int!` --- **`originMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`originMbomId`**: `Int` --- **`originPartInventory`**: `PartInventory` --- **`originPartInventoryId`**: `Int` --- **`originRuns`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`parentLocations`**: `[Location]` --- **`parentPartInventories`**: `[PartInventory]` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[PartInventory]` --- **`partKitInventories`**: `[PartKitInventory]` **Arguments:** - `filters`: `PartKitInventoriesInputFilters` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKits`**: `[PartKit]` Part kits that this inventory is kitted to. --- **`percentAbomInstalled`**: `Int` Percent of build requirements that are fulfilled. Each build requirement is given an equal weight in the calculation. --- **`poLinesCount`**: `Int!` --- **`prettyStr`**: `String` --- **`projectedReleaseStatus`**: `InventoryStatus` The status this inventory would re-derive to if its review were resolved as release. Null unless awaiting review. --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`qualityHoldsCount`**: `Int!` --- **`quantityAvailable`**: `Float` Quantity available that is ready to be consumed. This is the quantity that is not in wip, kitted, installed, or scrapped. --- **`quantityInstalled`**: `Float` Quantity installed onto parent parts. --- **`quantityIssued`**: `Float` See quantity_kitted for more info. > Deprecated: This was replaced by quantity_kitted. --- **`quantityKitted`**: `Float` Quantity kitted to open kits. Open means that the kit status is not complete or canceled. --- **`quantityNotScrapped`**: `String` --- **`quantityScrapped`**: `Float!` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receipts`**: `[Receipt]` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`received`**: `Boolean` True if the inventory's full quantity is received. --- **`receivedOrCreatedDate`**: `DateTime!` --- **`receivedPoLinesCount`**: `Int!` --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`serialNumber`**: `String` --- **`serviceDueDate`**: `DateTime` --- **`status`**: `InventoryStatus` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. --- **`trackingType`**: `Trackingtypeenum` The tracking type defined by the inventory. For instance, if a serial number is populated on the inventory, this will be 'serial'. --- **`unavailable`**: `Boolean!` --- **`unitOfMeasure`**: `UnitOfMeasurement` **Arguments:** - `filters`: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureId`**: `Int` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`uri`**: `String` --- **`usageType`**: `String` # IssuesConnection Source: https://docs.firstresonance.io/api-reference/types/IssuesConnection **Kind**: `object` ## Fields **`edges`**: `[IssuesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # IssuesEdge Source: https://docs.firstresonance.io/api-reference/types/IssuesEdge A Relay edge containing a `Issues` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Issue` The item at the end of the edge # Issuestatusenum Source: https://docs.firstresonance.io/api-reference/types/Issuestatusenum **Kind**: `enum` ## Values **`IN_PROGRESS`** **`IN_REVIEW`** **`PENDING`** **`RESOLVED`** # IssuestatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/IssuestatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Issuestatusenum` --- **`gt`**: `Issuestatusenum` --- **`gte`**: `Issuestatusenum` --- **`ilike`**: `Issuestatusenum` --- **`in`**: `[Issuestatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Issuestatusenum` --- **`lt`**: `Issuestatusenum` --- **`lte`**: `Issuestatusenum` --- **`neq`**: `Issuestatusenum` --- **`notilike`**: `Issuestatusenum` --- **`notlike`**: `Issuestatusenum` # JSONString Source: https://docs.firstresonance.io/api-reference/types/JSONString Allows use of a JSON String for input / output from the GraphQL schema. Use of this type is *not recommended* as you lose the benefits of having a defined, static schema (one of the key benefits of GraphQL). **Kind**: `scalar` # JSONStringFilter Source: https://docs.firstresonance.io/api-reference/types/JSONStringFilter **Kind**: `input` ## Fields **`eq`**: `JSONString` --- **`gt`**: `JSONString` --- **`gte`**: `JSONString` --- **`ilike`**: `JSONString` --- **`in`**: `[JSONString]` --- **`isnull`**: `Boolean` --- **`like`**: `JSONString` --- **`lt`**: `JSONString` --- **`lte`**: `JSONString` --- **`neq`**: `JSONString` --- **`notilike`**: `JSONString` --- **`notlike`**: `JSONString` # JSONStringNullFilter Source: https://docs.firstresonance.io/api-reference/types/JSONStringNullFilter **Kind**: `input` ## Fields **`isnull`**: `Boolean` # Jobstatusenum Source: https://docs.firstresonance.io/api-reference/types/Jobstatusenum **Kind**: `enum` ## Values **`COMPLETE`** **`FAILED`** **`IN_PROGRESS`** **`QUEUED`** # JobstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/JobstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Jobstatusenum` --- **`gt`**: `Jobstatusenum` --- **`gte`**: `Jobstatusenum` --- **`ilike`**: `Jobstatusenum` --- **`in`**: `[Jobstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Jobstatusenum` --- **`lt`**: `Jobstatusenum` --- **`lte`**: `Jobstatusenum` --- **`neq`**: `Jobstatusenum` --- **`notilike`**: `Jobstatusenum` --- **`notlike`**: `Jobstatusenum` # Label Source: https://docs.firstresonance.io/api-reference/types/Label A graphql label object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_EntitiesCount`**: `Int` Optimized count of entities. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LabelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String` # LabelEventFilter Source: https://docs.firstresonance.io/api-reference/types/LabelEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # LabelEvents Source: https://docs.firstresonance.io/api-reference/types/LabelEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Label` --- **`oldValues`**: `Label` --- **`timestamp`**: `DateTime` # LabelSortEnum Source: https://docs.firstresonance.io/api-reference/types/LabelSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # LabelToItemInput Source: https://docs.firstresonance.io/api-reference/types/LabelToItemInput Inputs to attach a label to an object through its entity id. **Kind**: `input` ## Fields **`entityId`**: `Int!` (required) --- **`labelId`**: `Int!` (required) # LabelToProcedureFamilyInput Source: https://docs.firstresonance.io/api-reference/types/LabelToProcedureFamilyInput Inputs needed to relate a label to a procedure family. **Kind**: `input` ## Fields **`familyId`**: `Int!` (required) --- **`labelId`**: `Int!` (required) # LabelsConnection Source: https://docs.firstresonance.io/api-reference/types/LabelsConnection **Kind**: `object` ## Fields **`edges`**: `[LabelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # LabelsEdge Source: https://docs.firstresonance.io/api-reference/types/LabelsEdge A Relay edge containing a `Labels` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Label` The item at the end of the edge # LabelsInputFilters Source: https://docs.firstresonance.io/api-reference/types/LabelsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[LabelsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[LabelsInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # LinkOrganizationToAuth0 Source: https://docs.firstresonance.io/api-reference/types/LinkOrganizationToAuth0 Link an existing organization to an Auth0 organization. Restricted to First Resonance administrators. Idempotent. **Kind**: `object` ## Fields **`organization`**: `LinkOrganizationToAuth0Result` # LinkOrganizationToAuth0Input Source: https://docs.firstresonance.io/api-reference/types/LinkOrganizationToAuth0Input **Kind**: `input` ## Fields **`displayName`**: `String` --- **`domain`**: `String!` (required) # LinkOrganizationToAuth0Result Source: https://docs.firstresonance.io/api-reference/types/LinkOrganizationToAuth0Result Lightweight result — avoids cross-schema SQLAlchemy object issues. **Kind**: `object` ## Fields **`auth0OrgId`**: `String` --- **`domain`**: `String` --- **`id`**: `Int` # LinkRunStepToPurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/LinkRunStepToPurchaseOrder Link an OSP run step to a purchase order. The backend resolves the correct action: - Part exists on PO (with or without inventory) → add run's inventory to that line. The PO line's quantity and part_id are left unchanged. - Part not on PO → create a new PO line (quantity from run's inventory). When the run is already linked to a different PO, only the POLI record for this run's inventory is removed from the old line — the old PO line itself is preserved along with any other runs' inventories on it. ``applyToAllRunStepsInBatch`` controls batch propagation. When the run step is part of a normalized batch and the flag is ``true`` (the default), the link is also applied to every batch sibling whose step is not terminal and whose run has a part inventory — including siblings currently linked elsewhere, which are moved to the target line. Set the flag to ``false`` to link only the specified run step. Errors: rejected with a ValidationError when the primary OR any sibling that this call would touch has been received — either the parent PO line's status is ``RECEIVED``, or the specific part inventory has already been recorded against a receipt for its current line (the line stays ``ORDERED`` for serial-tracked lines with multiple POLIs until every POLI is received, but each individually received POLI is locked from that moment on). Received POLIs are part of the receipt audit trail and cannot be moved. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` # LinkRunStepToPurchaseOrderInput Source: https://docs.firstresonance.io/api-reference/types/LinkRunStepToPurchaseOrderInput Input for linking a run step to an existing purchase order for outside processing. When the run step is part of a normalized batch and ``applyToAllRunStepsInBatch`` is ``true`` (the default), the link is also applied to every batch sibling — siblings already linked to a different PO are MOVED to the target PO. When ``false``, only the specified run step is linked and batch siblings are left untouched. **Kind**: `input` ## Fields **`applyToAllRunStepsInBatch`**: `Boolean` = true When true (the default) and the run step belongs to a normalized batch, the link is propagated to every batch sibling whose step is not in a terminal status and whose run has a part inventory — including siblings currently linked to a different PO, a different line of the target PO, or a cancelled line of the target PO, which are all moved to the target line. When false, only the specified run step is linked and batch siblings are left untouched. If the field is omitted or sent as null, the default (true) applies. --- **`purchaseOrderId`**: `ID!` (required) --- **`runStepId`**: `Int!` (required) # Location Source: https://docs.firstresonance.io/api-reference/types/Location The Location of a Part in the PartsInventory. **Kind**: `object` ## Fields **`Attributes`**: `[LocationAttribute]` **Arguments:** - `filters`: `LocationAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AllChildrenCount`**: `Int` --- **`_AllParentsCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_ExpectedPartKitsCount`**: `Int` Optimized count of expectedPartKits. --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PartKitsCount`**: `Int` Optimized count of partKits. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_UsersCount`**: `Int` Optimized count of users. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`address`**: `String` --- **`allChildren`**: `[Location]` --- **`allParents`**: `[Location]` --- **`archived`**: `Boolean!` --- **`attributedParts`**: `[LocationAttributedPart]` **Arguments:** - `filters`: `LocationAttributedPartsInputFilters` --- **`attributedUsers`**: `[LocationAttributedUser]` **Arguments:** - `filters`: `LocationAttributedUsersInputFilters` --- **`attributes`**: `[LocationAttribute]` --- **`available`**: `Boolean!` --- **`canHoldInventory`**: `Boolean!` --- **`contact`**: `Contact` **Arguments:** - `filters`: `ContactsInputFilters` --- **`contactId`**: `Int` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`excludeFromMergePartInventory`**: `Boolean` Exclude the location from inventory merge (V2 merge only). --- **`expectedPartKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`id`**: `Int!` --- **`image`**: `FileAttachment` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`imageId`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`latitude`**: `Float` --- **`locationSubtype`**: `LocationSubtype` **Arguments:** - `filters`: `LocationSubtypesInputFilters` --- **`locationSubtypeId`**: `Int` --- **`locations`**: `[Location]` --- **`longitude`**: `Float` --- **`name`**: `String!` --- **`parent`**: `Location` --- **`parentId`**: `Int` --- **`parentName`**: `String` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`pickSequence`**: `Int` --- **`pickable`**: `Boolean!` --- **`prettyStr`**: `String` --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` --- **`supervisor`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`supervisorId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LocationEventFilter` --- **`type`**: `Locationtypeenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`users`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` # LocationAttribute Source: https://docs.firstresonance.io/api-reference/types/LocationAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LocationAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # LocationAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/LocationAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`locationId`**: `IDFilter` --- **`options`**: `StringFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # LocationAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/LocationAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `LocationAttribute` --- **`oldValues`**: `LocationAttribute` --- **`timestamp`**: `DateTime` # LocationAttributedPart Source: https://docs.firstresonance.io/api-reference/types/LocationAttributedPart Auto-generated GQL type for LocationAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # LocationAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/LocationAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[LocationAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[LocationAttributedPartsInputFilters]` # LocationAttributedUser Source: https://docs.firstresonance.io/api-reference/types/LocationAttributedUser Auto-generated GQL type for LocationAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # LocationAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/LocationAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[LocationAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[LocationAttributedUsersInputFilters]` # LocationAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/LocationAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[LocationAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[LocationAttributesInputFilters]` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # LocationEventFilter Source: https://docs.firstresonance.io/api-reference/types/LocationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`address`**: `StringFilter` --- **`archived`**: `BooleanFilter` --- **`available`**: `BooleanFilter` --- **`canHoldInventory`**: `BooleanFilter` --- **`contactId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`excludeFromMergePartInventory`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`imageId`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`latitude`**: `FloatFilter` --- **`locationSubtypeId`**: `IDFilter` --- **`longitude`**: `FloatFilter` --- **`name`**: `StringFilter` --- **`parentId`**: `IDFilter` --- **`pickSequence`**: `IntFilter` --- **`pickable`**: `BooleanFilter` --- **`supervisorId`**: `IDFilter` --- **`type`**: `LocationtypeenumFilter` --- **`updatedById`**: `IDFilter` # LocationEvents Source: https://docs.firstresonance.io/api-reference/types/LocationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Location` --- **`oldValues`**: `Location` --- **`timestamp`**: `DateTime` # LocationSettings Source: https://docs.firstresonance.io/api-reference/types/LocationSettings Organization settings related to locations. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`enforceCanHoldInventory`**: `Boolean` --- **`enforcePickable`**: `Boolean` # LocationSettingsInput Source: https://docs.firstresonance.io/api-reference/types/LocationSettingsInput Input settings related to locations. **Kind**: `input` ## Fields **`enforceCanHoldInventory`**: `Boolean` --- **`enforcePickable`**: `Boolean` # LocationSortEnum Source: https://docs.firstresonance.io/api-reference/types/LocationSortEnum **Kind**: `enum` ## Values **`ADDRESS_ASC`** **`ADDRESS_DESC`** **`ARCHIVED_ASC`** **`ARCHIVED_DESC`** **`AVAILABLE_ASC`** **`AVAILABLE_DESC`** **`CAN_HOLD_INVENTORY_ASC`** **`CAN_HOLD_INVENTORY_DESC`** **`CONTACT_ID_ASC`** **`CONTACT_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`EXCLUDE_FROM_MERGE_PART_INVENTORY_ASC`** **`EXCLUDE_FROM_MERGE_PART_INVENTORY_DESC`** **`ID_ASC`** **`ID_DESC`** **`IMAGE_ID_ASC`** **`IMAGE_ID_DESC`** **`LATITUDE_ASC`** **`LATITUDE_DESC`** **`LOCATION_SUBTYPE_ID_ASC`** **`LOCATION_SUBTYPE_ID_DESC`** **`LONGITUDE_ASC`** **`LONGITUDE_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PICKABLE_ASC`** **`PICKABLE_DESC`** **`PICK_SEQUENCE_ASC`** **`PICK_SEQUENCE_DESC`** **`SUPERVISOR_ID_ASC`** **`SUPERVISOR_ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # LocationSubtype Source: https://docs.firstresonance.io/api-reference/types/LocationSubtype Subtype of locations. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` **Arguments:** - `filters`: `LocationsInputFilters` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `LocationSubtypeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # LocationSubtypeEventFilter Source: https://docs.firstresonance.io/api-reference/types/LocationSubtypeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`updatedById`**: `IDFilter` # LocationSubtypeEvents Source: https://docs.firstresonance.io/api-reference/types/LocationSubtypeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `LocationSubtype` --- **`oldValues`**: `LocationSubtype` --- **`timestamp`**: `DateTime` # LocationSubtypeSortEnum Source: https://docs.firstresonance.io/api-reference/types/LocationSubtypeSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # LocationSubtypesConnection Source: https://docs.firstresonance.io/api-reference/types/LocationSubtypesConnection **Kind**: `object` ## Fields **`edges`**: `[LocationSubtypesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # LocationSubtypesEdge Source: https://docs.firstresonance.io/api-reference/types/LocationSubtypesEdge A Relay edge containing a `LocationSubtypes` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `LocationSubtype` The item at the end of the edge # LocationSubtypesInputFilters Source: https://docs.firstresonance.io/api-reference/types/LocationSubtypesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[LocationSubtypesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`id`**: `IDFilter` --- **`locations`**: `LocationsInputFilters` --- **`name`**: `StringFilter` --- **`or_`**: `[LocationSubtypesInputFilters]` --- **`steps`**: `StepsFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # LocationsConnection Source: https://docs.firstresonance.io/api-reference/types/LocationsConnection **Kind**: `object` ## Fields **`edges`**: `[LocationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # LocationsEdge Source: https://docs.firstresonance.io/api-reference/types/LocationsEdge A Relay edge containing a `Locations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Location` The item at the end of the edge # LocationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/LocationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`address`**: `StringFilter` --- **`allChildren`**: `LocationsInputFilters` --- **`allParents`**: `LocationsInputFilters` --- **`and_`**: `[LocationsInputFilters]` --- **`archived`**: `BooleanFilter` --- **`attributedParts`**: `LocationAttributedPartsInputFilters` --- **`attributedUsers`**: `LocationAttributedUsersInputFilters` --- **`attributes`**: `LocationAttributesInputFilters` --- **`available`**: `BooleanFilter` --- **`canHoldInventory`**: `BooleanFilter` --- **`contact`**: `ContactsInputFilters` --- **`contactId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`excludeFromMergePartInventory`**: `BooleanFilter` --- **`expectedPartKits`**: `PartKitsInputFilters` --- **`id`**: `IDFilter` --- **`image`**: `FileAttachmentsInputFilters` --- **`imageId`**: `IDFilter` --- **`latitude`**: `FloatFilter` --- **`locationSubtype`**: `LocationSubtypesInputFilters` --- **`locationSubtypeId`**: `IDFilter` --- **`longitude`**: `FloatFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[LocationsInputFilters]` --- **`parentId`**: `IDFilter` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`partKits`**: `PartKitsInputFilters` --- **`pickSequence`**: `IntFilter` --- **`pickable`**: `BooleanFilter` --- **`runSteps`**: `RunStepsInputFilters` --- **`steps`**: `StepsFilters` --- **`supervisor`**: `UserInputFilters` --- **`supervisorId`**: `IDFilter` --- **`type`**: `LocationtypeenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`users`**: `UserInputFilters` # Locationtypeenum Source: https://docs.firstresonance.io/api-reference/types/Locationtypeenum **Kind**: `enum` ## Values **`RACK`** **`SHELF`** **`TOTE`** **`WAREHOUSE`** **`WORKCENTER`** # LocationtypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/LocationtypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Locationtypeenum` --- **`gt`**: `Locationtypeenum` --- **`gte`**: `Locationtypeenum` --- **`ilike`**: `Locationtypeenum` --- **`in`**: `[Locationtypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Locationtypeenum` --- **`lt`**: `Locationtypeenum` --- **`lte`**: `Locationtypeenum` --- **`neq`**: `Locationtypeenum` --- **`notilike`**: `Locationtypeenum` --- **`notlike`**: `Locationtypeenum` # LoggedAction Source: https://docs.firstresonance.io/api-reference/types/LoggedAction A logged action event. **Kind**: `object` ## Fields **`action`**: `LoggedActionType` --- **`apiClientId`**: `Int` --- **`changedFields`**: `JSONString` --- **`depth`**: `Int` --- **`eventId`**: `Int` --- **`id`**: `ID` --- **`joinerTableName`**: `String` --- **`modelId`**: `Int` --- **`operationId`**: `String` --- **`parentEventId`**: `Int` --- **`rootEventId`**: `Int` --- **`rootModelId`**: `Int` --- **`rootTableId`**: `Int` --- **`rootTableName`**: `TableNameEnum` --- **`rowData`**: `JSONString` --- **`tableId`**: `Int` --- **`tableName`**: `TableNameEnum` --- **`timestamp`**: `DateTime!` --- **`transactionId`**: `Float` --- **`user`**: `User` User column, as a declared attribute so it can inherited. **Arguments:** - `filters`: `UserInputFilters` --- **`userId`**: `Int` user_id column, as a declared attribute so it can inherited. # LoggedActionSortEnum Source: https://docs.firstresonance.io/api-reference/types/LoggedActionSortEnum **Kind**: `enum` ## Values **`ACTION_ASC`** **`ACTION_DESC`** **`CHANGED_FIELDS_ASC`** **`CHANGED_FIELDS_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`EVENT_ID_ASC`** **`EVENT_ID_DESC`** **`JOINER_TABLE_NAME_ASC`** **`JOINER_TABLE_NAME_DESC`** **`MODEL_ID_ASC`** **`MODEL_ID_DESC`** **`OPERATION_ID_ASC`** **`OPERATION_ID_DESC`** **`PARENT_EVENT_ID_ASC`** **`PARENT_EVENT_ID_DESC`** **`ROOT_EVENT_ID_ASC`** **`ROOT_EVENT_ID_DESC`** **`ROOT_MODEL_ID_ASC`** **`ROOT_MODEL_ID_DESC`** **`ROOT_TABLE_ID_ASC`** **`ROOT_TABLE_ID_DESC`** **`ROOT_TABLE_NAME_ASC`** **`ROOT_TABLE_NAME_DESC`** **`ROW_DATA_ASC`** **`ROW_DATA_DESC`** **`TABLE_ID_ASC`** **`TABLE_ID_DESC`** **`TABLE_NAME_ASC`** **`TABLE_NAME_DESC`** **`TIMESTAMP_ASC`** **`TIMESTAMP_DESC`** **`TRANSACTION_ID_ASC`** **`TRANSACTION_ID_DESC`** **`USER_ID_ASC`** **`USER_ID_DESC`** # LoggedActionType Source: https://docs.firstresonance.io/api-reference/types/LoggedActionType Enum class for event types. **Kind**: `enum` ## Values **`CHILD_ADDED`** **`CHILD_CHANGED`** **`CHILD_REMOVED`** **`CHILD_SET`** **`CHILD_UNSET`** **`CREATE`** **`DELETE`** **`UPDATE`** # LoggedActionTypeFilter Source: https://docs.firstresonance.io/api-reference/types/LoggedActionTypeFilter **Kind**: `input` ## Fields **`eq`**: `LoggedActionType` --- **`gt`**: `LoggedActionType` --- **`gte`**: `LoggedActionType` --- **`ilike`**: `LoggedActionType` --- **`in`**: `[LoggedActionType]` --- **`isnull`**: `Boolean` --- **`like`**: `LoggedActionType` --- **`lt`**: `LoggedActionType` --- **`lte`**: `LoggedActionType` --- **`neq`**: `LoggedActionType` --- **`notilike`**: `LoggedActionType` --- **`notlike`**: `LoggedActionType` # LoggedActionsConnection Source: https://docs.firstresonance.io/api-reference/types/LoggedActionsConnection **Kind**: `object` ## Fields **`edges`**: `[LoggedActionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # LoggedActionsEdge Source: https://docs.firstresonance.io/api-reference/types/LoggedActionsEdge A Relay edge containing a `LoggedActions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `LoggedAction` The item at the end of the edge # LoggedActionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/LoggedActionsInputFilters **Kind**: `input` ## Fields **`action`**: `LoggedActionTypeFilter` --- **`and_`**: `[LoggedActionsInputFilters]` --- **`changedFields`**: `JSONStringFilter` --- **`depth`**: `IntFilter` --- **`eventId`**: `IDFilter` --- **`joinerTableName`**: `StringFilter` --- **`modelId`**: `IntFilter` --- **`operationId`**: `StringFilter` --- **`or_`**: `[LoggedActionsInputFilters]` --- **`parentEventId`**: `IDFilter` --- **`rootEventId`**: `IntFilter` --- **`rootModelId`**: `IntFilter` --- **`rootTableId`**: `IntFilter` --- **`rootTableName`**: `TableNameEnumFilter` --- **`rowData`**: `JSONStringFilter` --- **`tableId`**: `IntFilter` --- **`tableName`**: `TableNameEnumFilter` --- **`timestamp`**: `DateTimeFilter` --- **`transactionId`**: `FloatFilter` --- **`user`**: `UserInputFilters` --- **`userId`**: `IDFilter` # MBom Source: https://docs.firstresonance.io/api-reference/types/MBom An mBOM. **Kind**: `object` ## Fields **`Attributes`**: `[MbomAttribute]` **Arguments:** - `filters`: `MbomAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MbomItemsCount`**: `Int` Optimized count of mbom items. --- **`_PartsInventoriesCount`**: `Int` Optimized count of partsInventories. --- **`_ProcedureMbomItemsCount`**: `Int` Optimized count of procedureMbomItems. --- **`_ProcedureMbomsCount`**: `Int` Optimized count of procedureMboms. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[MBomApprovalRequest]` **Arguments:** - `filters`: `MBomApprovalRequestsInputFilters` --- **`approvals`**: `[MBomApproval]` **Arguments:** - `filters`: `MBomApprovalsInputFilters` --- **`attributedParts`**: `[MBomAttributedPart]` **Arguments:** - `filters`: `MBomAttributedPartsInputFilters` --- **`attributedUsers`**: `[MBomAttributedUser]` **Arguments:** - `filters`: `MBomAttributedUsersInputFilters` --- **`attributes`**: `[MbomAttribute]` --- **`comments`**: `[Comment]` **Arguments:** - `filters`: `CommentsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `Int!` --- **`isLatestReleasedVersion`**: `Boolean` --- **`isLatestVersion`**: `Boolean` --- **`labels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItems`**: `[MBomItem]` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partsInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`prettyStr`**: `String` --- **`procedureMbomItems`**: `[ProcedureMBomItem]` **Arguments:** - `filters`: `ProcedureMBomItemsInputFilters` --- **`procedureMboms`**: `[ProcedureMBom]` **Arguments:** - `filters`: `ProcedureMBomsInputFilters` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`status`**: `Mbomstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`version`**: `Int!` # MBomApproval Source: https://docs.firstresonance.io/api-reference/types/MBomApproval An approval related to an mBOM. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Mbomapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int!` --- **`parent`**: `MBomApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[MBomApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MBomApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `MbomapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mbomId`**: `IDFilter` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # MBomApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBomApproval` --- **`oldValues`**: `MBomApproval` --- **`timestamp`**: `DateTime` # MBomApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequest A request to approve an mbom. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Mbomapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int!` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MBomApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `MbomapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mbomId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # MBomApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBomApprovalRequest` --- **`oldValues`**: `MBomApprovalRequest` --- **`timestamp`**: `DateTime` # MBomApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ID_ASC`** **`MBOM_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[MBomApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequestsEdge A Relay edge containing a `MBomApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomApprovalRequest` The item at the end of the edge # MBomApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRequestsInputFilters MBomApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `MbomapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`or_`**: `[MBomApprovalRequestsInputFilters]` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MBomApprovalRole Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRole Approval role type for mBOMs. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`gateType`**: `Mbomapprovalgatetypeenum!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomApprovalRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MBomApprovalRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `MbomapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # MBomApprovalRoleEvents Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBomApprovalRole` --- **`oldValues`**: `MBomApprovalRole` --- **`timestamp`**: `DateTime` # MBomApprovalRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomApprovalRolesConnection Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRolesConnection **Kind**: `object` ## Fields **`edges`**: `[MBomApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomApprovalRolesEdge Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRolesEdge A Relay edge containing a `MBomApprovalRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomApprovalRole` The item at the end of the edge # MBomApprovalRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalRolesInputFilters MBomApprovalRole filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomApprovalRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`gateType`**: `MbomapprovalgatetypeenumFilter` --- **`or_`**: `[MBomApprovalRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MBomApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ID_ASC`** **`MBOM_ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[MBomApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalsEdge A Relay edge containing a `MBomApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomApproval` The item at the end of the edge # MBomApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomApprovalsInputFilters MBomApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `MbomapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`or_`**: `[MBomApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MBomAttributedPart Source: https://docs.firstresonance.io/api-reference/types/MBomAttributedPart Auto-generated GQL type for MBomAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # MBomAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[MBomAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[MBomAttributedPartsInputFilters]` # MBomAttributedUser Source: https://docs.firstresonance.io/api-reference/types/MBomAttributedUser Auto-generated GQL type for MBomAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # MBomAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[MBomAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[MBomAttributedUsersInputFilters]` # MBomEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partId`**: `IDFilter` --- **`status`**: `MbomstatusenumFilter` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # MBomEvents Source: https://docs.firstresonance.io/api-reference/types/MBomEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBom` --- **`oldValues`**: `MBom` --- **`timestamp`**: `DateTime` # MBomExplosionConnection Source: https://docs.firstresonance.io/api-reference/types/MBomExplosionConnection **Kind**: `object` ## Fields **`edges`**: `[MBomExplosionEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. # MBomExplosionEdge Source: https://docs.firstresonance.io/api-reference/types/MBomExplosionEdge A Relay edge containing a `MBomExplosion` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomExplosionNode` The item at the end of the edge # MBomExplosionInput Source: https://docs.firstresonance.io/api-reference/types/MBomExplosionInput Inputs for exploding an mBOM. **Kind**: `input` ## Fields **`mbomId`**: `ID` Root mBOM version. Defaults to the part's released mBOM, else its latest. Nested levels always use released-else-latest. --- **`partId`**: `ID!` (required) Root assembly part. # MBomExplosionNode Source: https://docs.firstresonance.io/api-reference/types/MBomExplosionNode **Kind**: `object` ## Implements - `Node` ## Fields **`id`**: `ID!` The ID of the object. --- **`level`**: `Int` Depth in the mBOM tree; root lines are level 1. --- **`mbomItem`**: `MBomItem` --- **`parentPartId`**: `ID` Part id of the assembly this line sits under. --- **`quantity`**: `Float` Per-assembly quantity of this line. --- **`totalQuantity`**: `Float` Quantity rolled up through the tree (parent total x line quantity). # MBomImporterType Source: https://docs.firstresonance.io/api-reference/types/MBomImporterType Enum for mBOM item importer. **Kind**: `enum` ## Values **`DEPTH`** **`LEVEL`** # MBomItem Source: https://docs.firstresonance.io/api-reference/types/MBomItem An mBOM Item. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_ParentCount`**: `Int` --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_ProcedureMbomItemsCount`**: `Int` Optimized count of procedureMbomItems. --- **`_ReferenceDesignatorsCount`**: `Int` Optimized count of referenceDesignators. --- **`_StepPartRequirementsCount`**: `Int` Optimized count of stepPartRequirements. --- **`_SubstitutesCount`**: `Int` Optimized count of substitutes. --- **`_created`**: `DateTime` --- **`_deleted`**: `Boolean` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`excludeFromKit`**: `Boolean!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`madeOnAssembly`**: `Boolean!` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int!` --- **`parent`**: `Part` --- **`parentId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`prettyStr`**: `String` --- **`procedureMbomItems`**: `[ProcedureMBomItem]` **Arguments:** - `filters`: `ProcedureMBomItemsInputFilters` --- **`quantity`**: `Float!` --- **`referenceDesignators`**: `[MBomItemReferenceDesignator]` **Arguments:** - `filters`: `MBomItemReferenceDesignatorsInputFilters` --- **`stepPartRequirements`**: `[StepPartRequirement]` **Arguments:** - `filters`: `StepPartRequirementsInputFilters` --- **`substitutes`**: `[MBomSubstitute]` **Arguments:** - `filters`: `MBomSubstituteInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MBomItemEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomItemEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Deleted`**: `BooleanFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`excludeFromKit`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`madeOnAssembly`**: `BooleanFilter` --- **`mbomId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedById`**: `IDFilter` # MBomItemEvents Source: https://docs.firstresonance.io/api-reference/types/MBomItemEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBomItem` --- **`oldValues`**: `MBomItem` --- **`timestamp`**: `DateTime` # MBomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignator An mBOM Item Reference Designator. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReferenceDesignatorAssignmentsCount`**: `Int` Optimized count of referenceDesignatorAssignments. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomItemReferenceDesignatorEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String!` # MBomItemReferenceDesignatorEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignatorEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mbomItemId`**: `IDFilter` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # MBomItemReferenceDesignatorEvents Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignatorEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBomItemReferenceDesignator` --- **`oldValues`**: `MBomItemReferenceDesignator` --- **`timestamp`**: `DateTime` # MBomItemReferenceDesignatorSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignatorSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ITEM_ID_ASC`** **`MBOM_ITEM_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomItemReferenceDesignatorsConnection Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignatorsConnection **Kind**: `object` ## Fields **`edges`**: `[MBomItemReferenceDesignatorsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomItemReferenceDesignatorsEdge Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignatorsEdge A Relay edge containing a `MBomItemReferenceDesignators` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomItemReferenceDesignator` The item at the end of the edge # MBomItemReferenceDesignatorsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomItemReferenceDesignatorsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomItemReferenceDesignatorsInputFilters]` --- **`buildRequirementReferenceDesignators`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`mbomItem`**: `MBomItemsInputFilters` --- **`mbomItemId`**: `IDFilter` --- **`or_`**: `[MBomItemReferenceDesignatorsInputFilters]` --- **`procedureReferenceDesignators`**: `ProcedureReferenceDesignatorsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # MBomItemSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomItemSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`EXCLUDE_FROM_KIT_ASC`** **`EXCLUDE_FROM_KIT_DESC`** **`ID_ASC`** **`ID_DESC`** **`MADE_ON_ASSEMBLY_ASC`** **`MADE_ON_ASSEMBLY_DESC`** **`MBOM_ID_ASC`** **`MBOM_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_DELETED_ASC`** **`_DELETED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomItemsConnection Source: https://docs.firstresonance.io/api-reference/types/MBomItemsConnection **Kind**: `object` ## Fields **`edges`**: `[MBomItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomItemsEdge Source: https://docs.firstresonance.io/api-reference/types/MBomItemsEdge A Relay edge containing a `MBomItems` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomItem` The item at the end of the edge # MBomItemsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomItemsInputFilters mBOM filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_deleted`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomItemsInputFilters]` --- **`buildRequirements`**: `BuildRequirementsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`excludeFromKit`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`madeOnAssembly`**: `BooleanFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`or_`**: `[MBomItemsInputFilters]` --- **`parent`**: `PartsInputFilters` --- **`parentId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partKitItems`**: `PartKitItemsInputFilters` --- **`procedureMbomItems`**: `ProcedureMBomItemsInputFilters` --- **`quantity`**: `FloatFilter` --- **`referenceDesignators`**: `MBomItemReferenceDesignatorsInputFilters` --- **`stepPartRequirements`**: `StepPartRequirementsInputFilters` --- **`substitutes`**: `MBomSubstituteInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MBomSettings Source: https://docs.firstresonance.io/api-reference/types/MBomSettings Organization settings related to mboms. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` # MBomSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VERSION_ASC`** **`VERSION_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomStatus Source: https://docs.firstresonance.io/api-reference/types/MBomStatus Enum for mBOM status. **Kind**: `enum` ## Values **`ARCHIVED`** **`DRAFT`** **`IN_REVIEW`** **`RELEASED`** # MBomSubstitute Source: https://docs.firstresonance.io/api-reference/types/MBomSubstitute A Substitute on an mBOM. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_BuildRequirementSubstitutesCount`**: `Int` Optimized count of buildRequirementSubstitutes. --- **`_ParentCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirementSubstitutes`**: `[BuildRequirementSubstitute]` **Arguments:** - `filters`: `BuildRequirementSubstitutesInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int!` --- **`parent`**: `Part` --- **`parentId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MBomSubstituteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MBomSubstituteEventFilter Source: https://docs.firstresonance.io/api-reference/types/MBomSubstituteEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mbomItemId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedById`**: `IDFilter` # MBomSubstituteEvents Source: https://docs.firstresonance.io/api-reference/types/MBomSubstituteEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MBomSubstitute` --- **`oldValues`**: `MBomSubstitute` --- **`timestamp`**: `DateTime` # MBomSubstituteInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomSubstituteInputFilters mBOM Substitute filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomSubstituteInputFilters]` --- **`buildRequirementSubstitutes`**: `BuildRequirementSubstitutesInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`mbomItem`**: `MBomItemsInputFilters` --- **`mbomItemId`**: `IDFilter` --- **`or_`**: `[MBomSubstituteInputFilters]` --- **`parent`**: `PartsInputFilters` --- **`parentId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MBomSubstituteSortEnum Source: https://docs.firstresonance.io/api-reference/types/MBomSubstituteSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ITEM_ID_ASC`** **`MBOM_ITEM_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MBomSubstitutesConnection Source: https://docs.firstresonance.io/api-reference/types/MBomSubstitutesConnection **Kind**: `object` ## Fields **`edges`**: `[MBomSubstitutesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomSubstitutesEdge Source: https://docs.firstresonance.io/api-reference/types/MBomSubstitutesEdge A Relay edge containing a `MBomSubstitutes` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBomSubstitute` The item at the end of the edge # MBomsConnection Source: https://docs.firstresonance.io/api-reference/types/MBomsConnection **Kind**: `object` ## Fields **`edges`**: `[MBomsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MBomsEdge Source: https://docs.firstresonance.io/api-reference/types/MBomsEdge A Relay edge containing a `MBoms` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MBom` The item at the end of the edge # MBomsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MBomsInputFilters mBOM filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MBomsInputFilters]` --- **`approvalRequests`**: `MBomApprovalRequestsInputFilters` --- **`approvals`**: `MBomApprovalsInputFilters` --- **`attributedParts`**: `MBomAttributedPartsInputFilters` --- **`attributedUsers`**: `MBomAttributedUsersInputFilters` --- **`attributes`**: `MbomAttributesInputFilters` --- **`comments`**: `CommentsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`isLatestReleasedVersion`**: `BooleanFilter` --- **`isLatestVersion`**: `BooleanFilter` --- **`labels`**: `LabelsInputFilters` --- **`mbomItemId`**: `IDFilter` --- **`mbomItems`**: `MBomItemsInputFilters` --- **`or_`**: `[MBomsInputFilters]` --- **`parent`**: `PartsInputFilters` --- **`parentId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partsInventories`**: `PartInventoriesInputFilters` --- **`procedureMbomItems`**: `ProcedureMBomItemsInputFilters` --- **`procedureMboms`**: `ProcedureMBomsInputFilters` --- **`procedureReferenceDesignators`**: `ProcedureReferenceDesignatorsInputFilters` --- **`status`**: `MbomstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # MRPJob Source: https://docs.firstresonance.io/api-reference/types/MRPJob MRP Job GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`endTime`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`failedReason`**: `String` --- **`id`**: `Int!` --- **`isLatest`**: `Boolean` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`startTime`**: `DateTime` --- **`status`**: `Jobstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MRPJobEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MRPJobEventFilter Source: https://docs.firstresonance.io/api-reference/types/MRPJobEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`failedReason`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`startTime`**: `DateTimeFilter` --- **`status`**: `JobstatusenumFilter` --- **`updatedById`**: `IDFilter` # MRPJobEvents Source: https://docs.firstresonance.io/api-reference/types/MRPJobEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MRPJob` --- **`oldValues`**: `MRPJob` --- **`timestamp`**: `DateTime` # MRPJobSortEnum Source: https://docs.firstresonance.io/api-reference/types/MRPJobSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`END_TIME_ASC`** **`END_TIME_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FAILED_REASON_ASC`** **`FAILED_REASON_DESC`** **`ID_ASC`** **`ID_DESC`** **`START_TIME_ASC`** **`START_TIME_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MRPJobsConnection Source: https://docs.firstresonance.io/api-reference/types/MRPJobsConnection **Kind**: `object` ## Fields **`edges`**: `[MRPJobsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MRPJobsEdge Source: https://docs.firstresonance.io/api-reference/types/MRPJobsEdge A Relay edge containing a `MRPJobs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MRPJob` The item at the end of the edge # MRPJobsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MRPJobsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MRPJobsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`failedReason`**: `StringFilter` --- **`id`**: `IDFilter` --- **`isLatest`**: `BooleanFilter` --- **`or_`**: `[MRPJobsInputFilters]` --- **`planItems`**: `PlanItemsInputFilters` --- **`startTime`**: `DateTimeFilter` --- **`status`**: `JobstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MaintenanceStatus Source: https://docs.firstresonance.io/api-reference/types/MaintenanceStatus Enum of Inventory maintenance status. **Kind**: `enum` ## Values **`AVAILABLE`** **`UNAVAILABLE`** # MaintenanceStatusFilter Source: https://docs.firstresonance.io/api-reference/types/MaintenanceStatusFilter **Kind**: `input` ## Fields **`eq`**: `MaintenanceStatus` --- **`gt`**: `MaintenanceStatus` --- **`gte`**: `MaintenanceStatus` --- **`ilike`**: `MaintenanceStatus` --- **`in`**: `[MaintenanceStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `MaintenanceStatus` --- **`lt`**: `MaintenanceStatus` --- **`lte`**: `MaintenanceStatus` --- **`neq`**: `MaintenanceStatus` --- **`notilike`**: `MaintenanceStatus` --- **`notlike`**: `MaintenanceStatus` # MbomAttribute Source: https://docs.firstresonance.io/api-reference/types/MbomAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MbomAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # MbomAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/MbomAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`mbomId`**: `IDFilter` --- **`options`**: `StringFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # MbomAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/MbomAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MbomAttribute` --- **`oldValues`**: `MbomAttribute` --- **`timestamp`**: `DateTime` # MbomAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/MbomAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[MbomAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[MbomAttributesInputFilters]` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # MbomChangeDiffType Source: https://docs.firstresonance.io/api-reference/types/MbomChangeDiffType Enum of mBOM change diff types (one row per build requirement). One row per requirement, never one per changed field: two rows on one requirement could carry contradictory resolutions, and the aBOM can't hold both answers at once. Every row carries a resolution, preset to a default that writes nothing destructive. **Kind**: `enum` ## Values **`BUILD_REQUIREMENT_ADDED`** **`BUILD_REQUIREMENT_REMOVED`** **`BUILD_REQUIREMENT_UPDATED`** # MbomChangeDiffTypeFilter Source: https://docs.firstresonance.io/api-reference/types/MbomChangeDiffTypeFilter **Kind**: `input` ## Fields **`eq`**: `MbomChangeDiffType` --- **`gt`**: `MbomChangeDiffType` --- **`gte`**: `MbomChangeDiffType` --- **`ilike`**: `MbomChangeDiffType` --- **`in`**: `[MbomChangeDiffType]` --- **`isnull`**: `Boolean` --- **`like`**: `MbomChangeDiffType` --- **`lt`**: `MbomChangeDiffType` --- **`lte`**: `MbomChangeDiffType` --- **`neq`**: `MbomChangeDiffType` --- **`notilike`**: `MbomChangeDiffType` --- **`notlike`**: `MbomChangeDiffType` # MbomChangeOrderCandidateInventoryConnection Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderCandidateInventoryConnection Relay connection of a change order's candidate inventories. **Kind**: `object` ## Fields **`edges`**: `[MbomChangeOrderCandidateInventoryEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MbomChangeOrderCandidateInventoryEdge Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderCandidateInventoryEdge A Relay edge containing a `MbomChangeOrderCandidateInventory` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MbomChangeOrderCandidateInventoryNode` The item at the end of the edge # MbomChangeOrderCandidateInventoryInputFilters Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderCandidateInventoryInputFilters Narrows the candidate list. Omit it to list every inventory of the part. **Kind**: `input` ## Fields **`ineligibleReason`**: `MbomChangeOrderIneligibilityReasonFilter` --- **`search`**: `String` Matches serial number or lot number, case insensitive. # MbomChangeOrderCandidateInventoryNode Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderCandidateInventoryNode One candidate inventory, with the verdict a create call would give it. ``id`` is the part inventory id, the same value as ``partInventory.id``. **Kind**: `object` ## Implements - `Node` ## Fields **`id`**: `ID!` --- **`ineligibleReason`**: `MbomChangeOrderIneligibilityReason` Null when the inventory can join the change order. Otherwise, the reason a create call would refuse it. When several apply, the first in this order wins: ON_THIS_CHANGE_ORDER, ON_ANOTHER_CHANGE_ORDER, EMPTY, RUN_STEP_MAPPED, SHARED_REQUIREMENTS. --- **`partInventory`**: `PartInventory` # MbomChangeOrderIneligibilityReason Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderIneligibilityReason Why a candidate inventory cannot join an mBOM change order. Values are listed in priority order: when more than one reason applies to one inventory, the candidate query reports the first one listed here. Each mirrors one entry guard in ``MbomChangeOrderLines.bulk_create``. **Kind**: `enum` ## Values **`EMPTY`** **`ON_ANOTHER_CHANGE_ORDER`** **`ON_THIS_CHANGE_ORDER`** **`RUN_STEP_MAPPED`** **`SHARED_REQUIREMENTS`** # MbomChangeOrderIneligibilityReasonFilter Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderIneligibilityReasonFilter Filters candidate inventories by their ineligibility verdict. ``isnull`` true selects the eligible set. ``in`` selects one or more reasons. Both apply together when both are given. **Kind**: `input` ## Fields **`in`**: `[MbomChangeOrderIneligibilityReason]` --- **`isnull`**: `Boolean` # MbomChangeOrderLine Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLine One inventory adopting the change order's target mBOM version. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`appliedAt`**: `DateTime` --- **`appliedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`appliedById`**: `Int` --- **`canceledAt`**: `DateTime` --- **`canceledBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`canceledById`**: `Int` --- **`changeOrder`**: `ChangeOrder` **Arguments:** - `filters`: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`diffs`**: `[MbomChangeOrderLineDiff]` --- **`hasDrift`**: `Boolean` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`sourceMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`sourceMbomId`**: `Int` --- **`status`**: `ChangeOrderLineStatus` --- **`targetMbom`**: `MBom` --- **`targetMbomId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MbomChangeOrderLineEventFilter` --- **`totalDiffCount`**: `Int` --- **`unconfirmedDiffCount`**: `Int` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MbomChangeOrderLineDesignatorState Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDesignatorState One reference designator inside a stored requirement state. **Kind**: `object` ## Fields **`id`**: `Int!` --- **`originMbomItemReferenceDesignatorId`**: `Int` --- **`value`**: `String!` # MbomChangeOrderLineDiff Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiff One differing build requirement of an mBOM change scope. A row is keyed by the target's part within its line. ``initialState`` is the requirement as it stood when the diff ran, and the drift baseline; ``finalState`` is the requirement as the apply left it, null until then and null where the apply left no requirement. The target side is read live through ``mbomItemId``. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` --- **`buildRequirementId`**: `Int` --- **`changeOrderId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`currentTotalQuantity`**: `Float` --- **`diffType`**: `MbomChangeDiffType!` --- **`finalState`**: `MbomChangeOrderLineRequirementState` --- **`id`**: `Int!` --- **`initialState`**: `MbomChangeOrderLineRequirementState` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomChangeOrderLine`**: `MbomChangeOrderLine` --- **`mbomChangeOrderLineId`**: `Int!` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`resolutionConfirmedAt`**: `DateTime` --- **`resolutionConfirmedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`resolutionConfirmedById`**: `Int` --- **`resolutionOptions`**: `[MbomChangeOrderLineResolutionOption]` --- **`resolutionType`**: `MbomChangeResolution` --- **`targetTotalQuantity`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `MbomChangeOrderLineDiffEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # MbomChangeOrderLineDiffEventFilter Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`changeOrderId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`diffType`**: `MbomChangeDiffTypeFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mbomChangeOrderLineId`**: `IDFilter` --- **`mbomItemId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`resolutionConfirmedAt`**: `DateTimeFilter` --- **`resolutionConfirmedById`**: `IDFilter` --- **`resolutionType`**: `MbomChangeResolutionFilter` --- **`updatedById`**: `IDFilter` # MbomChangeOrderLineDiffEvents Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MbomChangeOrderLineDiff` --- **`oldValues`**: `MbomChangeOrderLineDiff` --- **`timestamp`**: `DateTime` # MbomChangeOrderLineDiffSortEnum Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffSortEnum **Kind**: `enum` ## Values **`BUILD_REQUIREMENT_ID_ASC`** **`BUILD_REQUIREMENT_ID_DESC`** **`CHANGE_ORDER_ID_ASC`** **`CHANGE_ORDER_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DIFF_TYPE_ASC`** **`DIFF_TYPE_DESC`** **`FINAL_STATE_ASC`** **`FINAL_STATE_DESC`** **`ID_ASC`** **`ID_DESC`** **`INITIAL_STATE_ASC`** **`INITIAL_STATE_DESC`** **`MBOM_CHANGE_ORDER_LINE_ID_ASC`** **`MBOM_CHANGE_ORDER_LINE_ID_DESC`** **`MBOM_ITEM_ID_ASC`** **`MBOM_ITEM_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`RESOLUTION_CONFIRMED_AT_ASC`** **`RESOLUTION_CONFIRMED_AT_DESC`** **`RESOLUTION_CONFIRMED_BY_ID_ASC`** **`RESOLUTION_CONFIRMED_BY_ID_DESC`** **`RESOLUTION_TYPE_ASC`** **`RESOLUTION_TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MbomChangeOrderLineDiffSourceInput Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffSourceInput One diff the caller is acting on. The etag is the row the caller saw. Resolving reads the server's copy, so without it a stale client could sign off, or broadcast, a value another reviewer chose and it never displayed. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) # MbomChangeOrderLineDiffsConnection Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffsConnection **Kind**: `object` ## Fields **`edges`**: `[MbomChangeOrderLineDiffsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MbomChangeOrderLineDiffsEdge Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffsEdge A Relay edge containing a `MbomChangeOrderLineDiffs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MbomChangeOrderLineDiff` The item at the end of the edge # MbomChangeOrderLineDiffsInputFilters Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDiffsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MbomChangeOrderLineDiffsInputFilters]` --- **`buildRequirementId`**: `IDFilter` --- **`changeOrderId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`diffType`**: `MbomChangeDiffTypeFilter` --- **`id`**: `IDFilter` --- **`mbomChangeOrderLineId`**: `IDFilter` --- **`mbomItem`**: `MBomItemsInputFilters` --- **`mbomItemId`**: `IDFilter` --- **`or_`**: `[MbomChangeOrderLineDiffsInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`resolutionConfirmedAt`**: `DateTimeFilter` --- **`resolutionConfirmedBy`**: `UserInputFilters` --- **`resolutionConfirmedById`**: `IDFilter` --- **`resolutionType`**: `MbomChangeResolutionFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MbomChangeOrderLineDrift Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDrift One line's drift: every part that moved since its diffs were computed. **Kind**: `object` ## Fields **`label`**: `String!` --- **`mbomChangeOrderLineId`**: `Int!` --- **`mismatches`**: `[MbomChangeOrderLineDriftMismatch]!` --- **`partInventoryId`**: `Int` # MbomChangeOrderLineDriftMismatch Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineDriftMismatch One part that no longer matches what this line's diffs recorded. ``sentence`` is the same wording apply's drift refusal uses, so a client can render it directly, or build its own copy from ``kind`` and ``partId`` instead. **Kind**: `object` ## Fields **`kind`**: `String!` --- **`partId`**: `Int!` --- **`partNumber`**: `String` --- **`sentence`**: `String!` # MbomChangeOrderLineEventFilter Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`appliedAt`**: `DateTimeFilter` --- **`appliedById`**: `IDFilter` --- **`canceledAt`**: `DateTimeFilter` --- **`canceledById`**: `IDFilter` --- **`changeOrderId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partInventoryId`**: `IDFilter` --- **`sourceMbomId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # MbomChangeOrderLineEvents Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `MbomChangeOrderLine` --- **`oldValues`**: `MbomChangeOrderLine` --- **`timestamp`**: `DateTime` # MbomChangeOrderLineRequirementState Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineRequirementState One build requirement, as a diff row stored it. ``quantity`` is the per-parent ratio; ``currentTotalQuantity`` on the diff scales it by the inventory. **Kind**: `object` ## Fields **`excludeFromKit`**: `Boolean` --- **`installedQuantity`**: `Float` --- **`madeOnAssembly`**: `Boolean` --- **`originMbomItemId`**: `Int` --- **`partId`**: `Int!` --- **`partNumber`**: `String` --- **`partRevision`**: `String` --- **`quantity`**: `Float` --- **`referenceDesignators`**: `[MbomChangeOrderLineDesignatorState]` --- **`substitutes`**: `[MbomChangeOrderLineSubstituteState]` # MbomChangeOrderLineResolutionOption Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineResolutionOption One resolution a diff row can take, with the engine's reasoning. Both lists, because several checks can refuse one resolution at once and the reviewer has to read every one to know what to clear. Empty rather than null when nothing applies. ``warnings`` is empty on a blocked option: it cannot be confirmed either way. Exactly one option in a row's list is the default. **Kind**: `object` ## Fields **`conflicts`**: `[String]!` --- **`default`**: `Boolean!` --- **`resolution`**: `MbomChangeResolution!` --- **`warnings`**: `[String]!` # MbomChangeOrderLineSortEnum Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineSortEnum **Kind**: `enum` ## Values **`APPLIED_AT_ASC`** **`APPLIED_AT_DESC`** **`APPLIED_BY_ID_ASC`** **`APPLIED_BY_ID_DESC`** **`CANCELED_AT_ASC`** **`CANCELED_AT_DESC`** **`CANCELED_BY_ID_ASC`** **`CANCELED_BY_ID_DESC`** **`CHANGE_ORDER_ID_ASC`** **`CHANGE_ORDER_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`SOURCE_MBOM_ID_ASC`** **`SOURCE_MBOM_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # MbomChangeOrderLineSourceInput Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineSourceInput One line the caller is acting on, with the etag it saw. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) # MbomChangeOrderLineSubstituteState Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLineSubstituteState One substitute part inside a stored requirement state. **Kind**: `object` ## Fields **`id`**: `Int!` --- **`originMbomSubstituteId`**: `Int` --- **`partId`**: `Int!` # MbomChangeOrderLinesConnection Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLinesConnection **Kind**: `object` ## Fields **`edges`**: `[MbomChangeOrderLinesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # MbomChangeOrderLinesEdge Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLinesEdge A Relay edge containing a `MbomChangeOrderLines` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `MbomChangeOrderLine` The item at the end of the edge # MbomChangeOrderLinesInput Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLinesInput Input for every batch mutation: one line or many. **Kind**: `input` ## Fields **`sources`**: `[MbomChangeOrderLineSourceInput]!` (required) # MbomChangeOrderLinesInputFilters Source: https://docs.firstresonance.io/api-reference/types/MbomChangeOrderLinesInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[MbomChangeOrderLinesInputFilters]` --- **`appliedAt`**: `DateTimeFilter` --- **`appliedBy`**: `UserInputFilters` --- **`appliedById`**: `IDFilter` --- **`canceledAt`**: `DateTimeFilter` --- **`canceledBy`**: `UserInputFilters` --- **`canceledById`**: `IDFilter` --- **`changeOrder`**: `ChangeOrdersInputFilters` --- **`changeOrderId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[MbomChangeOrderLinesInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`sourceMbom`**: `MBomsInputFilters` --- **`sourceMbomId`**: `IDFilter` --- **`status`**: `ChangeOrderLineStatusFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # MbomChangeResolution Source: https://docs.firstresonance.io/api-reference/types/MbomChangeResolution Enum of legal resolutions for mBOM change diffs. **Kind**: `enum` ## Values **`ADD_NEW_BUILD_REQUIREMENT`** **`KEEP_AS_EXTRA_BUILD_REQUIREMENT`** **`KEEP_BUILD_REQUIREMENT_AS_IS`** **`REMOVE_BUILD_REQUIREMENT`** **`UPDATE_BUILD_REQUIREMENT`** **`WAIVE_NEW_BUILD_REQUIREMENT`** # MbomChangeResolutionFilter Source: https://docs.firstresonance.io/api-reference/types/MbomChangeResolutionFilter **Kind**: `input` ## Fields **`eq`**: `MbomChangeResolution` --- **`gt`**: `MbomChangeResolution` --- **`gte`**: `MbomChangeResolution` --- **`ilike`**: `MbomChangeResolution` --- **`in`**: `[MbomChangeResolution]` --- **`isnull`**: `Boolean` --- **`like`**: `MbomChangeResolution` --- **`lt`**: `MbomChangeResolution` --- **`lte`**: `MbomChangeResolution` --- **`neq`**: `MbomChangeResolution` --- **`notilike`**: `MbomChangeResolution` --- **`notlike`**: `MbomChangeResolution` # Mbomapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Mbomapprovalgatetypeenum **Kind**: `enum` ## Values **`RELEASED`** # MbomapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/MbomapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Mbomapprovalgatetypeenum` --- **`gt`**: `Mbomapprovalgatetypeenum` --- **`gte`**: `Mbomapprovalgatetypeenum` --- **`ilike`**: `Mbomapprovalgatetypeenum` --- **`in`**: `[Mbomapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Mbomapprovalgatetypeenum` --- **`lt`**: `Mbomapprovalgatetypeenum` --- **`lte`**: `Mbomapprovalgatetypeenum` --- **`neq`**: `Mbomapprovalgatetypeenum` --- **`notilike`**: `Mbomapprovalgatetypeenum` --- **`notlike`**: `Mbomapprovalgatetypeenum` # Mbomstatusenum Source: https://docs.firstresonance.io/api-reference/types/Mbomstatusenum **Kind**: `enum` ## Values **`ARCHIVED`** **`DRAFT`** **`IN_REVIEW`** **`RELEASED`** # MbomstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/MbomstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Mbomstatusenum` --- **`gt`**: `Mbomstatusenum` --- **`gte`**: `Mbomstatusenum` --- **`ilike`**: `Mbomstatusenum` --- **`in`**: `[Mbomstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Mbomstatusenum` --- **`lt`**: `Mbomstatusenum` --- **`lte`**: `Mbomstatusenum` --- **`neq`**: `Mbomstatusenum` --- **`notilike`**: `Mbomstatusenum` --- **`notlike`**: `Mbomstatusenum` # MergeMultiplePartInventory Source: https://docs.firstresonance.io/api-reference/types/MergeMultiplePartInventory Bulk merge disposition for a batched aBOM uninstall's freed lots (V2-only, atomic). No-op unless the org enables inventory merging. **Kind**: `object` ## Fields **`partInventories`**: `[PartInventory]` --- **`partInventoryIds`**: `[Int]` # MergeMultiplePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/MergeMultiplePartInventoryInput Inputs needed to bulk-merge PartInventory objects (V2, per group). **Kind**: `input` ## Fields **`partInventoryIds`**: `[Int]!` (required) # MergePartInventory Source: https://docs.firstresonance.io/api-reference/types/MergePartInventory Merge part inventory list into the oldest id given. Mutation will fail if *any* ids given are not valid for merge. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` # MergePartInventoryEachInput Source: https://docs.firstresonance.io/api-reference/types/MergePartInventoryEachInput Input for each inventory output of a split many operation. **Kind**: `input` ## Fields **`id`**: `Int!` (required) # MergePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/MergePartInventoryInput Inputs needed to merge PartInventory objects. **Kind**: `input` ## Fields **`partInventories`**: `[MergePartInventoryEachInput]!` (required) # MergePartInventoryV2 Source: https://docs.firstresonance.io/api-reference/types/MergePartInventoryV2 Merge Part Inventories V2. Mutation will fail if there are no merge candidates. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` --- **`partInventoryIds`**: `[Int]` # MergePartInventoryV2Input Source: https://docs.firstresonance.io/api-reference/types/MergePartInventoryV2Input Inputs needed to merge PartInventory objects (V2). **Kind**: `input` ## Fields **`partInventoryId`**: `Int!` (required) # MergeRunStep Source: https://docs.firstresonance.io/api-reference/types/MergeRunStep (Deprecated) Merge run step into procedure step. This mutation has been deprecated in favor of MergeRunStepToProcedure. **Kind**: `object` ## Fields **`step`**: `Step` # MergeRunStepInput Source: https://docs.firstresonance.io/api-reference/types/MergeRunStepInput (Deprecated) Inputs to merge run step into procedure. This input has been deprecated in favor of MergeRunStepToProcedureInput. **Kind**: `input` ## Fields **`etag`**: `String` Merge target step etag (not required). --- **`id`**: `ID!` (required) Merge source run step id. --- **`procedureId`**: `ID!` (required) --- **`stepId`**: `ID` Merge target step id (not required). # MergeRunStepToProcedure Source: https://docs.firstresonance.io/api-reference/types/MergeRunStepToProcedure Merge run step into procedure step. **Kind**: `object` ## Fields **`step`**: `Step` # MergeRunStepToProcedureInput Source: https://docs.firstresonance.io/api-reference/types/MergeRunStepToProcedureInput Inputs to merge run step into procedure. If no step_id is passed run step is merged into new step in procedure, else merged into existing specified step. **Kind**: `input` ## Fields **`etag`**: `String` Merge target step etag (not required). --- **`id`**: `ID!` (required) Merge source run step id. --- **`procedureId`**: `ID!` (required) --- **`stepId`**: `ID` Merge target step id (not required). # MergeRunStepToRunInput Source: https://docs.firstresonance.io/api-reference/types/MergeRunStepToRunInput Inputs to specify target for run step to be merged onto. **Kind**: `input` ## Fields **`etag`**: `String` --- **`runId`**: `ID!` (required) --- **`runStepId`**: `ID` # MergeRunStepToRuns Source: https://docs.firstresonance.io/api-reference/types/MergeRunStepToRuns Merge a redlined run step onto other runs/run steps. **Kind**: `object` ## Fields **`steps`**: `[RunStep]` # MergeRunStepToRunsInput Source: https://docs.firstresonance.io/api-reference/types/MergeRunStepToRunsInput Inputs to specify targets for run step to be merged onto. **Kind**: `input` ## Fields **`id`**: `ID!` (required) --- **`runs`**: `[MergeRunStepToRunInput]!` (required) # MessageResponse Source: https://docs.firstresonance.io/api-reference/types/MessageResponse Event response type. **Kind**: `object` ## Fields **`messageId`**: `ID` # MoveItemToInventory Source: https://docs.firstresonance.io/api-reference/types/MoveItemToInventory Moves an item to inventory given its inventory and part kit ids. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` --- **`splitInventory`**: `PartInventory` # MoveKitInventoryToLocation Source: https://docs.firstresonance.io/api-reference/types/MoveKitInventoryToLocation Move all inventory in a kit to one location. **Kind**: `object` ## Fields **`partKit`**: `PartKit` # MoveKitInventoryToLocationInput Source: https://docs.firstresonance.io/api-reference/types/MoveKitInventoryToLocationInput Inputs needed to move all inventory in a kit to one location. **Kind**: `input` ## Fields **`etag`**: `String!` (required) Etag of the part kit. --- **`locationId`**: `ID!` (required) --- **`partKitId`**: `ID!` (required) # MultipleMbomCreationErrors Source: https://docs.firstresonance.io/api-reference/types/MultipleMbomCreationErrors MBom importer results. Empty if no errors. **Kind**: `object` ## Fields **`errorMsg`**: `String!` --- **`rowId`**: `Int!` # NestedExtensibleAttributeInput Source: https://docs.firstresonance.io/api-reference/types/NestedExtensibleAttributeInput Input to upsert extensible attributes within a nested mutation. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`value`**: `ScalarValue` # Node Source: https://docs.firstresonance.io/api-reference/types/Node An object with an ID **Kind**: `interface` ## Fields **`id`**: `ID!` The ID of the object. ## Possible types - `DemandGapNode` - `MBomExplosionNode` - `MbomChangeOrderCandidateInventoryNode` - `PartInventoryHistoryNode` # NotificationTypeEnum Source: https://docs.firstresonance.io/api-reference/types/NotificationTypeEnum **Kind**: `enum` ## Values **`APPROVAL_REQUEST`** **`CHANGE_ORDER_APPROVAL_REQUEST_ASSIGNED`** **`CHANGE_ORDER_STATUS_CHANGED`** **`COMMENT`** **`DATAGRID_VALUE_ASSIGNED`** **`EXTERNAL`** **`FURTHER_ACTION_APPROVAL_REQUEST_ASSIGNED`** **`FURTHER_ACTION_ASSIGNED`** **`FURTHER_ACTION_STATUS_CHANGED`** **`IMPORT_JOB_COMPLETED`** **`INSPECTION_RUN`** **`ISSUE_APPROVAL_REQUEST_ASSIGNED`** **`ISSUE_ASSIGNED`** **`ISSUE_CREATED`** **`ISSUE_STATUS_CHANGED`** **`MBOM_APPROVAL_REQUEST_ASSIGNED`** **`MBOM_CHANGE_APPLIED`** **`MBOM_RELEASED`** **`MBOM_STATUS_CHANGED`** **`MENTION`** **`PART_KIT_ASSIGNED`** **`PART_KIT_STATUS_CHANGED`** **`PROCEDURE_APPROVAL_REQUEST_ASSIGNED`** **`PROCEDURE_RELEASED`** **`PROCEDURE_STATUS_CHANGED`** **`PURCHASE_ORDER_ASSIGNED`** **`REDLINE_APPROVAL_REQUEST_ASSIGNED`** **`REVIEW`** **`REVIEW_REQUEST`** **`RUN_ASSIGNED`** **`RUN_STEP_ASSIGNED`** **`RUN_STEP_CHANGE`** **`RUN_STEP_FIELD_ASSIGNED`** **`SIGNOFF`** **`STEP_APPROVAL_REQUEST_ASSIGNED`** **`WARNING`** # NotificationTypeEnumFilter Source: https://docs.firstresonance.io/api-reference/types/NotificationTypeEnumFilter **Kind**: `input` ## Fields **`eq`**: `NotificationTypeEnum` --- **`gt`**: `NotificationTypeEnum` --- **`gte`**: `NotificationTypeEnum` --- **`ilike`**: `NotificationTypeEnum` --- **`in`**: `[NotificationTypeEnum]` --- **`isnull`**: `Boolean` --- **`like`**: `NotificationTypeEnum` --- **`lt`**: `NotificationTypeEnum` --- **`lte`**: `NotificationTypeEnum` --- **`neq`**: `NotificationTypeEnum` --- **`notilike`**: `NotificationTypeEnum` --- **`notlike`**: `NotificationTypeEnum` # OAuthAppRegistrationObject Source: https://docs.firstresonance.io/api-reference/types/OAuthAppRegistrationObject A customer's registered OAuth application. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`appType`**: `String` --- **`callbackUris`**: `[OAuthRedirectUriObject]` --- **`clientId`**: `String` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` --- **`id`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`logoutUris`**: `[OAuthRedirectUriObject]` --- **`name`**: `String` --- **`originUris`**: `[OAuthRedirectUriObject]` # OAuthRedirectUriObject Source: https://docs.firstresonance.io/api-reference/types/OAuthRedirectUriObject A registered redirect URI or allowed origin for an OAuth app. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`createdById`**: `Int` --- **`id`**: `Int` --- **`uri`**: `String` --- **`uriType`**: `String` # Organization Source: https://docs.firstresonance.io/api-reference/types/Organization Users and Settings related to the Ion platform. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`aiAccessEnabled`**: `Boolean` Whether this org may use AI: eligibility AND the org's own opt-in. This is the predicate services enforce, including for work with no user in scope. --- **`aiAccessEnabledForCurrentUser`**: `Boolean` Whether this org's AI settings permit the requesting user: eligibility AND the org's opt-in. Org-wide, so the same for every user. Read this instead of combining the parts yourself. Clients use it to hide AI surfaces; the enforcing boundary is kraftor, which refuses on the same predicate. --- **`aiConsentRequired`**: `Boolean` Whether enabling ION Intelligence now needs a fresh acceptance of the AI Terms of Service. True before the first acceptance, after a version bump, and after the org has turned AI off — consent authorises one activation, not every future one. Clients read this to decide whether to present the terms. --- **`aiEligible`**: `Boolean` Whether First Resonance has made this org eligible for ION Intelligence. Clients use this to decide whether to offer the opt-in control at all; an ineligible org has nothing to consent to. --- **`aiEnabled`**: `Boolean` Whether this org's admins have turned ION Intelligence on. Org-wide: everyone or nobody. Only half of access — First Resonance must also have made the org eligible. --- **`allowWipOspKitting`**: `Boolean!` --- **`auth0Domain`**: `String` Auth0 tenant domain for token endpoint. --- **`auth0OrgId`**: `String` --- **`authField`**: `String` --- **`avatar`**: `String` --- **`branding`**: `OrganizationBrandingType` Branding settings for the organization's Auth0 login page. --- **`createdByApiClient`**: `ApiClientAttribution` --- **`domain`**: `String!` --- **`enableInventoryDisposition`**: `Boolean!` --- **`enforceCanHoldInventory`**: `Boolean!` --- **`enforcePickable`**: `Boolean!` --- **`enforcePlanReservations`**: `Boolean!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String` --- **`oauthApps`**: `[OAuthAppRegistrationObject]` Registered OAuth applications for this organization. --- **`oauthEnabled`**: `Boolean` Whether OAuth app registration is available in this environment. --- **`orgSchema`**: `String!` --- **`proceduresRoleBasedApprovalEnabled`**: `Boolean` Whether role-based procedure approvals are active for this org (vs the legacy reviewer-count model). --- **`settings`**: `OrganizationSettings` --- **`settingsStructured`**: `String` --- **`ssoConnectionId`**: `String` --- **`ssoProviderType`**: `String` --- **`users`**: `[User]` # OrganizationBrandingType Source: https://docs.firstresonance.io/api-reference/types/OrganizationBrandingType Branding settings for an Auth0 Organization. **Kind**: `object` ## Fields **`logoUrl`**: `String` --- **`pageBackgroundColor`**: `String` --- **`primaryColor`**: `String` # OrganizationDomain Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomain **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`auth0DomainId`**: `String!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`domain`**: `String!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`status`**: `DomainStatusEnum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `OrganizationDomainEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`verificationHost`**: `String` --- **`verificationToken`**: `String!` --- **`verifiedAt`**: `DateTime` # OrganizationDomainEventFilter Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomainEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`auth0DomainId`**: `StringFilter` --- **`createdById`**: `IDFilter` --- **`domain`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`status`**: `DomainStatusEnumFilter` --- **`updatedById`**: `IDFilter` --- **`verificationHost`**: `StringFilter` --- **`verificationToken`**: `StringFilter` --- **`verifiedAt`**: `DateTimeFilter` # OrganizationDomainEvents Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomainEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `OrganizationDomain` --- **`oldValues`**: `OrganizationDomain` --- **`timestamp`**: `DateTime` # OrganizationDomainSortEnum Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomainSortEnum **Kind**: `enum` ## Values **`AUTH0_DOMAIN_ID_ASC`** **`AUTH0_DOMAIN_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DOMAIN_ASC`** **`DOMAIN_DESC`** **`ID_ASC`** **`ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VERIFICATION_HOST_ASC`** **`VERIFICATION_HOST_DESC`** **`VERIFICATION_TOKEN_ASC`** **`VERIFICATION_TOKEN_DESC`** **`VERIFIED_AT_ASC`** **`VERIFIED_AT_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # OrganizationDomainsConnection Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomainsConnection **Kind**: `object` ## Fields **`edges`**: `[OrganizationDomainsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # OrganizationDomainsEdge Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomainsEdge A Relay edge containing a `OrganizationDomains` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `OrganizationDomain` The item at the end of the edge # OrganizationDomainsInputFilters Source: https://docs.firstresonance.io/api-reference/types/OrganizationDomainsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[OrganizationDomainsInputFilters]` --- **`auth0DomainId`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`domain`**: `StringFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[OrganizationDomainsInputFilters]` --- **`status`**: `DomainStatusEnumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`verificationHost`**: `StringFilter` --- **`verificationToken`**: `StringFilter` --- **`verifiedAt`**: `DateTimeFilter` # OrganizationSettings Source: https://docs.firstresonance.io/api-reference/types/OrganizationSettings Organizational settings. **Kind**: `object` ## Fields **`aboms`**: `ABomSettings` --- **`admin`**: `AdminSettings` --- **`ai`**: `AiSettings` > Deprecated: Superseded by Organization.aiEnabled. Always null. --- **`datetimeFormat`**: `String` --- **`furtherActions`**: `FurtherActionSettings` --- **`intent`**: `IntentSettings` --- **`issues`**: `IssueSettings` --- **`locations`**: `LocationSettings` --- **`mboms`**: `MBomSettings` --- **`numReviewersRequired`**: `Int` --- **`partKitItems`**: `PartKitItemSettings` --- **`parts`**: `PartSettings` --- **`partsInventory`**: `PartInventorySettings` --- **`partsKits`**: `PartKitSettings` --- **`pickRuns`**: `PickRunSettings` --- **`plans`**: `PlanSettings` --- **`printLabels`**: `PrintLabelSettings` --- **`procedures`**: `ProcedureSettings` --- **`purchaseOrderLines`**: `PurchaseOrderLineSettings` --- **`purchaseOrders`**: `PurchaseOrderSettings` --- **`receipts`**: `ReceiptSettings` --- **`redlines`**: `RedlineSettings` --- **`rules`**: `RuleSettings` --- **`runSteps`**: `RunStepSettings` --- **`runs`**: `RunSettings` --- **`steps`**: `StepSettings` --- **`suppliers`**: `SupplierSettings` # OrganizationSettingsInput Source: https://docs.firstresonance.io/api-reference/types/OrganizationSettingsInput Organizational settings input. **Kind**: `input` ## Fields **`aboms`**: `ABomSettingsInput` --- **`admin`**: `AdminSettingsInput` --- **`ai`**: `AiSettingsInput` --- **`datetimeFormat`**: `String` --- **`furtherActions`**: `FurtherActionSettingsInput` --- **`intent`**: `IntentSettingsInput` --- **`issues`**: `IssueSettingsInput` --- **`locations`**: `LocationSettingsInput` --- **`numReviewersRequired`**: `Int` --- **`parts`**: `PartsSettingsInput` --- **`partsInventory`**: `PartInventorySettingsInput` --- **`partsKits`**: `PartKitSettingsInput` --- **`pickRuns`**: `PickRunSettingsInput` --- **`plans`**: `PlanSettingsInput` --- **`printLabels`**: `PrintLabelSettingsInput` --- **`procedures`**: `ProcedureSettingsInput` --- **`purchaseOrders`**: `PurchaseOrderSettingsInput` --- **`redlines`**: `RedlineSettingsInput` --- **`rules`**: `RuleSettingsInput` --- **`runSteps`**: `RunStepSettingsInput` --- **`runs`**: `RunSettingsInput` --- **`steps`**: `StepSettingsInput` # PageInfo Source: https://docs.firstresonance.io/api-reference/types/PageInfo The Relay compliant `PageInfo` type, containing data necessary to paginate this connection. **Kind**: `object` ## Fields **`endCursor`**: `String` When paginating forwards, the cursor to continue. --- **`hasNextPage`**: `Boolean!` When paginating forwards, are there more items? --- **`hasPreviousPage`**: `Boolean!` When paginating backwards, are there more items? --- **`startCursor`**: `String` When paginating backwards, the cursor to continue. # Part Source: https://docs.firstresonance.io/api-reference/types/Part A Part related to a Run or Procedure. **Kind**: `object` ## Fields **`Attributes`**: `[PartAttribute]` **Arguments:** - `filters`: `PartAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`LatestRevisionScheme`**: `String` --- **`MbomItemSubstitutes`**: `[MBomSubstitute]` **Arguments:** - `filters`: `MBomSubstituteInputFilters` --- **`MbomItems`**: `[MBomItem]` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`SubstituteMbom`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BuildRequirementSubstitutesCount`**: `Int` Optimized count of buildRequirementSubstitutes. --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FurtherActionsCount`**: `Int` Optimized count of furtherActions. --- **`_InputsCount`**: `Int` Optimized count of inputs. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MbomItemSubstitutesCount`**: `Int` Optimized count of MbomItemSubstitutes. --- **`_MbomItemsCount`**: `Int` Optimized count of MbomItems. --- **`_MbomsCount`**: `Int` Optimized count of mboms. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_PartProceduresCount`**: `Int` Optimized count of partProcedures. --- **`_PartSubtypesCount`**: `Int` Optimized count of partSubtypes. --- **`_PartsInventoryCount`**: `Int` Optimized count of partsInventory. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_ProceduresCount`**: `Int` Optimized count of procedures. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_RequirementsCount`**: `Int` Optimized count of requirements. --- **`_RevisionsCount`**: `Int` Optimized count of revisions. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_SupplierPartsCount`**: `Int` Optimized count of supplierParts. --- **`_UnitOfMeasureConflictsCount`**: `Int` Optimized count of unitOfMeasureConflicts. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[PartAttributedPart]` **Arguments:** - `filters`: `PartAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartAttributedUser]` **Arguments:** - `filters`: `PartAttributedUsersInputFilters` --- **`attributes`**: `[PartAttribute]` --- **`buildRequirementSubstitutes`**: `[BuildRequirementSubstitute]` **Arguments:** - `filters`: `BuildRequirementSubstitutesInputFilters` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`comments`**: `[Comment]` --- **`cost`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`demandTotal`**: `Float` --- **`description`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`exportControlled`**: `Boolean` --- **`fileAttachments`**: `[FileAttachment]` --- **`furtherActions`**: `[FurtherAction]` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`hasInventory`**: `Boolean!` True when part.purchaseType is RECEIVABLE_INVENTORY. > Deprecated: Use purchaseType instead. --- **`id`**: `Int!` --- **`independentDemandTotal`**: `Float` --- **`inputs`**: `[PlanInput]` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` --- **`isLatestRevision`**: `Boolean` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`latestMbom`**: `MBom` --- **`latestReleasedMbom`**: `MBom` --- **`latestReleasedMbomWithFallback`**: `MBom` --- **`latestRevision`**: `String` --- **`leadTime`**: `Int` --- **`maintenanceIntervalSeconds`**: `Int` --- **`mbom`**: `[MBomItem]` --- **`mboms`**: `[MBom]` **Arguments:** - `filters`: `MBomsInputFilters` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partNumber`**: `String!` --- **`partProcedures`**: `[PartProcedure]` **Arguments:** - `filters`: `PartProceduresInputFilters` --- **`partSubtypes`**: `[PartSubtype]` **Arguments:** - `filters`: `PartSubtypesInputFilters` --- **`partType`**: `Parttypeenum!` --- **`partsInventory`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`procedures`**: `[Procedure]` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseType`**: `purchasetypeenum` --- **`quantity`**: `Int` --- **`reorderMaximumQuantity`**: `Float` --- **`reorderMinimumQuantity`**: `Float` --- **`requirements`**: `[Requirement]` --- **`revisedFrom`**: `Part` --- **`revisedFromId`**: `Int` --- **`revision`**: `String!` --- **`revisionScheme`**: `String` --- **`revisions`**: `[Part]` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`sourcingStrategy`**: `Sourcingstrategyenum` --- **`status`**: `Partstatusenum!` --- **`supplierPartNumber`**: `String` Use supplierPartNumber on SupplierParts instead. > Deprecated: Supplier part number has moved to SupplierParts. --- **`supplierParts`**: `[SupplierPart]` **Arguments:** - `filters`: `SupplierPartsInputFilters` --- **`surplusTotal`**: `Float` --- **`thumbnail`**: `FileAttachment` **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`thumbnailId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartEventFilter` --- **`trackingType`**: `Trackingtypeenum` --- **`unitOfMeasure`**: `UnitOfMeasurement` **Arguments:** - `filters`: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureConflicts`**: `[PartUnitOfMeasureConflict]` --- **`unitOfMeasureId`**: `Int!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PartAttribute Source: https://docs.firstresonance.io/api-reference/types/PartAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PartAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`partId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PartAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PartAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartAttribute` --- **`oldValues`**: `PartAttribute` --- **`timestamp`**: `DateTime` # PartAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PartAttributedPart Auto-generated GQL type for PartAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` --- **`key`**: `String!` # PartAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartAttributedPartsInputFilters]` # PartAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PartAttributedUser Auto-generated GQL type for PartAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PartAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartAttributedUsersInputFilters]` # PartAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PartAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PartAttributesInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PartEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`LatestRevisionScheme`**: `StringFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`cost`**: `FloatFilter` --- **`createdById`**: `IDFilter` --- **`demandTotal`**: `FloatFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`hasInventory`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`independentDemandTotal`**: `FloatFilter` --- **`intentOptionId`**: `IDFilter` --- **`isLatestRevision`**: `BooleanFilter` --- **`latestRevision`**: `StringFilter` --- **`leadTime`**: `IntFilter` --- **`maintenanceIntervalSeconds`**: `IntFilter` --- **`partNumber`**: `StringFilter` --- **`partType`**: `ParttypeenumFilter` --- **`purchaseType`**: `purchasetypeenumFilter` --- **`reorderMaximumQuantity`**: `FloatFilter` --- **`reorderMinimumQuantity`**: `FloatFilter` --- **`revisedFromId`**: `IDFilter` --- **`revision`**: `StringFilter` --- **`revisionScheme`**: `StringFilter` --- **`sourcingStrategy`**: `SourcingstrategyenumFilter` --- **`status`**: `PartstatusenumFilter` --- **`supplierPartNumber`**: `StringFilter` --- **`surplusTotal`**: `FloatFilter` --- **`thumbnailId`**: `IDFilter` --- **`trackingType`**: `TrackingtypeenumFilter` --- **`unitOfMeasureId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # PartEvents Source: https://docs.firstresonance.io/api-reference/types/PartEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Part` --- **`oldValues`**: `Part` --- **`timestamp`**: `DateTime` # PartInventoriesConnection Source: https://docs.firstresonance.io/api-reference/types/PartInventoriesConnection **Kind**: `object` ## Fields **`aggregates`**: `AggregatesField!` --- **`edges`**: `[PartInventoriesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartInventoriesEdge Source: https://docs.firstresonance.io/api-reference/types/PartInventoriesEdge A Relay edge containing a `PartInventories` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartInventory` The item at the end of the edge # PartInventoriesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoriesInputFilters PartInventory filterable fields. **Kind**: `input` ## Fields **`_cost`**: `FloatFilter` --- **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`abomInstallations`**: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `IntFilter` --- **`activeKitId`**: `IntFilter` --- **`and_`**: `[PartInventoriesInputFilters]` --- **`attributedParts`**: `PartInventoryAttributedPartsInputFilters` --- **`attributedUsers`**: `PartInventoryAttributedUsersInputFilters` --- **`attributes`**: `PartInventoryAttributesInputFilters` --- **`awaitingReview`**: `BooleanFilter` --- **`buildRequirementReferenceDesignators`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirements`**: `BuildRequirementsInputFilters` --- **`canceledPoLinesCount`**: `IntFilter` --- **`cost`**: `FloatFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`estimatedArrival`**: `DateTimeFilter` --- **`estimatedTotalCost`**: `FloatFilter` --- **`failedRunsCount`**: `IntFilter` --- **`howCreated`**: `InventoryEventTypeFilter` --- **`howLastSplit`**: `InventoryEventTypeFilter` --- **`id`**: `IDFilter` --- **`identity`**: `StringFilter` --- **`installed`**: `BooleanFilter` --- **`installedOnBuildRequirement`**: `BuildRequirementsInputFilters` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IDFilter` --- **`isLinkedToOspPoLine`**: `BooleanFilter` --- **`isLocationAvailable`**: `BooleanFilter` --- **`issues`**: `IssueInputFilters` --- **`kitted`**: `BooleanFilter` --- **`labels`**: `LabelsInputFilters` --- **`lastMaintainedDate`**: `DateTimeFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`lotNumber`**: `StringFilter` --- **`madeOnAssemblyParentPartInventoryId`**: `IDFilter` --- **`maintenanceStatus`**: `MaintenanceStatusFilter` --- **`mergeCandidateIds`**: `IntFilter` --- **`mergeCandidateIdsV2`**: `IntFilter` --- **`needDate`**: `DateTimeFilter` --- **`openPoLinesCount`**: `IntFilter` --- **`openRunsCount`**: `IntFilter` --- **`or_`**: `[PartInventoriesInputFilters]` --- **`originMbom`**: `MBomsInputFilters` --- **`originMbomId`**: `IDFilter` --- **`originPartInventoryId`**: `IDFilter` --- **`originRuns`**: `RunsInputFilters` --- **`parentLocations`**: `LocationsInputFilters` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partKitItems`**: `PartKitItemsInputFilters` --- **`percentAbomInstalled`**: `IntFilter` --- **`poLinesCount`**: `IntFilter` --- **`projectedReleaseStatus`**: `InventoryStatusFilter` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`qualityHoldsCount`**: `IntFilter` --- **`quantity`**: `FloatFilter` --- **`quantityAvailable`**: `FloatFilter` --- **`quantityInstalled`**: `FloatFilter` --- **`quantityIssued`**: `FloatFilter` --- **`quantityKitted`**: `FloatFilter` --- **`quantityScrapped`**: `FloatFilter` --- **`receiptItems`**: `ReceiptItemsInputFilters` --- **`receipts`**: `ReceiptsInputFilters` --- **`received`**: `BooleanFilter` --- **`receivedOrCreatedDate`**: `DateTimeFilter` --- **`receivedPoLinesCount`**: `IntFilter` --- **`runSteps`**: `RunStepsInputFilters` --- **`runs`**: `RunsInputFilters` --- **`serialNumber`**: `StringFilter` --- **`serviceDueDate`**: `DateTimeFilter` --- **`status`**: `InventoryStatusFilter` --- **`supplier`**: `SuppliersInputFilters` --- **`supplierId`**: `IDFilter` --- **`unavailable`**: `BooleanFilter` --- **`unitOfMeasure`**: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`uri`**: `StringFilter` # PartInventory Source: https://docs.firstresonance.io/api-reference/types/PartInventory Inventories related to parts. **Kind**: `object` ## Fields **`Attributes`**: `[PartInventoryAttribute]` **Arguments:** - `filters`: `PartInventoryAttributesInputFilters` --- **`Cost`**: `Float` --- **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BuildRequirementReferenceDesignatorsCount`**: `Int` Optimized count of buildRequirementReferenceDesignators. --- **`_BuildRequirementsCount`**: `Int` Optimized count of buildRequirements. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_InstalledOnBuildRequirementCount`**: `Int` Optimized count of installedOnBuildRequirement. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_MadeOnAssemblyChildPartInventoriesCount`**: `Int` Optimized count of madeOnAssemblyChildPartInventories. --- **`_MbomChangesCount`**: `Int` Optimized count of mbomChanges. --- **`_OriginRunsCount`**: `Int` Optimized count of originRuns. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of partKitInventories. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_PartKitsCount`**: `Int` --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_ReceiptsCount`**: `Int` Optimized count of receipts. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`abomInstallationsCount`**: `Int!` --- **`activeKitId`**: `Int` The most recent active kit that the part inventory is in. --- **`attributedParts`**: `[PartInventoryAttributedPart]` **Arguments:** - `filters`: `PartInventoryAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartInventoryAttributedUser]` **Arguments:** - `filters`: `PartInventoryAttributedUsersInputFilters` --- **`attributes`**: `[PartInventoryAttribute]` --- **`awaitingReview`**: `Boolean!` True while this inventory awaits human review; status derives to needs_review until a review resolution or lifecycle event clears it. --- **`buildRequirementReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirements`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`canceledPoLinesCount`**: `Int!` --- **`comments`**: `[Comment]` --- **`cost`**: `Float` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrival`**: `DateTime` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`estimatedTotalCost`**: `Float` --- **`failedRunsCount`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`howCreated`**: `InventoryEventType` --- **`howLastSplit`**: `InventoryEventType` --- **`id`**: `Int!` --- **`identifiable`**: `Boolean` True if the inventory has a serial number, lot number, or location. This is used to determine if an inventory can be deleted when used on a purchase order line and the line is canceled. --- **`identity`**: `String` --- **`installed`**: `Boolean` True if the inventory's full quantity is installed onto a parent part. --- **`installedOnBuildRequirement`**: `[BuildRequirement]` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`installedPartInventories`**: `[PartInventory]` --- **`installs`**: `[ABomInstallation]` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isLinkedToOspPoLine`**: `Boolean` True if this inventory is linked to a PO line via an outside processing (OSP) run step: the linking record has a run step set and that run step is marked as outside processing. Used to allow kitting of WIP inventory for OSP. --- **`isLocationAvailable`**: `Boolean!` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`kitted`**: `Boolean` True if the inventory's full quantity is actively kitted. --- **`labels`**: `[Label]` --- **`lastMaintainedDate`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`lotNumber`**: `String` --- **`madeOnAssemblyChildPartInventories`**: `[PartInventory]` --- **`madeOnAssemblyParentPartInventory`**: `PartInventory` --- **`madeOnAssemblyParentPartInventoryId`**: `Int` --- **`maintenanceStatus`**: `MaintenanceStatus` --- **`mbomChanges`**: `[MbomChangeOrderLine]` Every mBOM change this unit has gone through (applied, in progress, and canceled), oldest first. --- **`mergeCandidateIds`**: `[Int]` --- **`mergeCandidateIdsV2`**: `[Int]` --- **`needDate`**: `DateTime` PO-specific property. > Deprecated: Moved to related purchaseOrderLines. --- **`openPoLinesCount`**: `Int!` --- **`openRunsCount`**: `Int!` --- **`originMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`originMbomId`**: `Int` --- **`originPartInventory`**: `PartInventory` --- **`originPartInventoryId`**: `Int` --- **`originRuns`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`parentLocations`**: `[Location]` --- **`parentPartInventories`**: `[PartInventory]` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[PartInventory]` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKits`**: `[PartKit]` Part kits that this inventory is kitted to. --- **`percentAbomInstalled`**: `Int` Percent of build requirements that are fulfilled. Each build requirement is given an equal weight in the calculation. --- **`poLinesCount`**: `Int!` --- **`prettyStr`**: `String` --- **`projectedReleaseStatus`**: `InventoryStatus` The status this inventory would re-derive to if its review were resolved as release. Null unless awaiting review. --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`qualityHoldsCount`**: `Int!` --- **`quantity`**: `Float!` --- **`quantityAvailable`**: `Float` Quantity available that is ready to be consumed. This is the quantity that is not in wip, kitted, installed, or scrapped. --- **`quantityInstalled`**: `Float` Quantity installed onto parent parts. --- **`quantityIssued`**: `Float` See quantity_kitted for more info. > Deprecated: This was replaced by quantity_kitted. --- **`quantityKitted`**: `Float` Quantity kitted to open kits. Open means that the kit status is not complete or canceled. --- **`quantityNotScrapped`**: `String` --- **`quantityScrapped`**: `Float!` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receipts`**: `[Receipt]` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`received`**: `Boolean` True if the inventory's full quantity is received. --- **`receivedOrCreatedDate`**: `DateTime!` --- **`receivedPoLinesCount`**: `Int!` --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`serialNumber`**: `String` --- **`serviceDueDate`**: `DateTime` --- **`status`**: `InventoryStatus` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartInventoryEventFilter` --- **`trackingType`**: `Trackingtypeenum` The tracking type defined by the inventory. For instance, if a serial number is populated on the inventory, this will be 'serial'. --- **`unavailable`**: `Boolean!` --- **`unitOfMeasure`**: `UnitOfMeasurement` **Arguments:** - `filters`: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureId`**: `Int` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`uri`**: `String` --- **`usageType`**: `String` # PartInventoryAttribute Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartInventoryAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PartInventoryAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`partInventoryId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PartInventoryAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartInventoryAttribute` --- **`oldValues`**: `PartInventoryAttribute` --- **`timestamp`**: `DateTime` # PartInventoryAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributedPart Auto-generated GQL type for PartInventoryAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # PartInventoryAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartInventoryAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartInventoryAttributedPartsInputFilters]` # PartInventoryAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributedUser Auto-generated GQL type for PartInventoryAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PartInventoryAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartInventoryAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartInventoryAttributedUsersInputFilters]` # PartInventoryAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PartInventoryAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PartInventoryAttributesInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PartInventoryBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirement Links part inventories to their child build requirements. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` Return the build_requirement relationship. **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`partInventory`**: `PartInventory` Return the part_inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartInventoryBuildRequirementEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PartInventoryBuildRequirementEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirementEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partInventoryId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # PartInventoryBuildRequirementEvents Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirementEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartInventoryBuildRequirement` --- **`oldValues`**: `PartInventoryBuildRequirement` --- **`timestamp`**: `DateTime` # PartInventoryBuildRequirementSortEnum Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirementSortEnum **Kind**: `enum` ## Values **`BUILD_REQUIREMENT_ID_ASC`** **`BUILD_REQUIREMENT_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartInventoryBuildRequirementsConnection Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirementsConnection **Kind**: `object` ## Fields **`edges`**: `[PartInventoryBuildRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartInventoryBuildRequirementsEdge Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirementsEdge A Relay edge containing a `PartInventoryBuildRequirements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartInventoryBuildRequirement` The item at the end of the edge # PartInventoryBuildRequirementsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryBuildRequirementsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartInventoryBuildRequirementsInputFilters]` --- **`buildRequirement`**: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`or_`**: `[PartInventoryBuildRequirementsInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PartInventoryEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartInventoryEventFilter **Kind**: `input` ## Fields **`Cost`**: `FloatFilter` --- **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`abomInstallationsCount`**: `IntFilter` --- **`activeKitId`**: `IntFilter` --- **`actor`**: `UserInputFilters` --- **`awaitingReview`**: `BooleanFilter` --- **`canceledPoLinesCount`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`estimatedArrival`**: `DateTimeFilter` --- **`eventType`**: `EventTypeFilter` --- **`failedRunsCount`**: `IntFilter` --- **`howCreated`**: `InventoryEventTypeFilter` --- **`howLastSplit`**: `InventoryEventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IDFilter` --- **`isLocationAvailable`**: `BooleanFilter` --- **`lastMaintainedDate`**: `DateTimeFilter` --- **`locationId`**: `IDFilter` --- **`lotNumber`**: `StringFilter` --- **`madeOnAssemblyParentPartInventoryId`**: `IDFilter` --- **`maintenanceStatus`**: `MaintenanceStatusFilter` --- **`mergeCandidateIdsV2`**: `IntFilter` --- **`needDate`**: `DateTimeFilter` --- **`openPoLinesCount`**: `IntFilter` --- **`openRunsCount`**: `IntFilter` --- **`originMbomId`**: `IDFilter` --- **`originPartInventoryId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`percentAbomInstalled`**: `IntFilter` --- **`poLinesCount`**: `IntFilter` --- **`projectedReleaseStatus`**: `InventoryStatusFilter` --- **`qualityHoldsCount`**: `IntFilter` --- **`quantity`**: `FloatFilter` --- **`quantityInstalled`**: `FloatFilter` --- **`quantityKitted`**: `FloatFilter` --- **`quantityScrapped`**: `FloatFilter` --- **`received`**: `BooleanFilter` --- **`receivedOrCreatedDate`**: `DateTimeFilter` --- **`receivedPoLinesCount`**: `IntFilter` --- **`serialNumber`**: `StringFilter` --- **`status`**: `InventoryStatusFilter` --- **`supplierId`**: `IDFilter` --- **`unavailable`**: `BooleanFilter` --- **`unitOfMeasureId`**: `IDFilter` --- **`updatedById`**: `IDFilter` --- **`uri`**: `StringFilter` # PartInventoryEvents Source: https://docs.firstresonance.io/api-reference/types/PartInventoryEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartInventory` --- **`oldValues`**: `PartInventory` --- **`timestamp`**: `DateTime` # PartInventoryHistoryAction Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryAction **Kind**: `object` ## Fields **`actionType`**: `PartInventoryHistoryActionType` --- **`actorData`**: `JSONString!` --- **`actorMetaInfo`**: `JSONString` --- **`actorModelId`**: `Int!` --- **`actorSecModelId`**: `Int` --- **`actorTableName`**: `PartInventoryHistoryActorTableName` --- **`id`**: `Float!` --- **`subjectId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartInventoryHistoryActionEventFilter` --- **`transactionId`**: `Float!` --- **`tstamp`**: `DateTime!` --- **`userId`**: `Int` # PartInventoryHistoryActionEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActionEventFilter **Kind**: `input` ## Fields **`actionType`**: `PartInventoryHistoryActionTypeFilter` --- **`actor`**: `UserInputFilters` --- **`actorData`**: `JSONStringFilter` --- **`actorMetainfo`**: `JSONStringFilter` --- **`actorModelId`**: `IntFilter` --- **`actorSecModelId`**: `IntFilter` --- **`actorTableName`**: `PartInventoryHistoryActorTableNameFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `FloatFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`subjectId`**: `IntFilter` --- **`transactionId`**: `FloatFilter` --- **`tstamp`**: `DateTimeFilter` --- **`userId`**: `IntFilter` # PartInventoryHistoryActionEvents Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartInventoryHistoryAction` --- **`oldValues`**: `PartInventoryHistoryAction` --- **`timestamp`**: `DateTime` # PartInventoryHistoryActionInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActionInputFilters **Kind**: `input` ## Fields **`actionType`**: `PartInventoryHistoryActionTypeFilter` --- **`actorData`**: `JSONStringFilter` --- **`actorMetainfo`**: `JSONStringFilter` --- **`actorModelId`**: `IntFilter` --- **`actorSecModelId`**: `IntFilter` --- **`actorTableName`**: `PartInventoryHistoryActorTableNameFilter` --- **`and_`**: `[PartInventoryHistoryActionInputFilters]` --- **`id`**: `FloatFilter` --- **`or_`**: `[PartInventoryHistoryActionInputFilters]` --- **`subjectId`**: `IntFilter` --- **`transactionId`**: `FloatFilter` --- **`tstamp`**: `DateTimeFilter` --- **`userId`**: `IntFilter` # PartInventoryHistoryActionType Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActionType **Kind**: `enum` ## Values **`CREATED`** **`DELETED`** **`INSTALLED_ON`** **`LINKED`** **`MERGED_FROM`** **`MERGED_INTO`** **`RECEIVED_INSTALL`** **`RECEIVED_UNINSTALL`** **`SPLIT_FROM`** **`SPLIT_TO`** **`UNINSTALLED_FROM`** **`UNLINKED`** **`UPDATED`** # PartInventoryHistoryActionTypeFilter Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActionTypeFilter **Kind**: `input` ## Fields **`eq`**: `PartInventoryHistoryActionType` --- **`gt`**: `PartInventoryHistoryActionType` --- **`gte`**: `PartInventoryHistoryActionType` --- **`ilike`**: `PartInventoryHistoryActionType` --- **`in`**: `[PartInventoryHistoryActionType]` --- **`isnull`**: `Boolean` --- **`like`**: `PartInventoryHistoryActionType` --- **`lt`**: `PartInventoryHistoryActionType` --- **`lte`**: `PartInventoryHistoryActionType` --- **`neq`**: `PartInventoryHistoryActionType` --- **`notilike`**: `PartInventoryHistoryActionType` --- **`notlike`**: `PartInventoryHistoryActionType` # PartInventoryHistoryActorTableName Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActorTableName **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS`** **`BUILD_REQUIREMENTS`** **`ENTITIES`** **`ENTITIES_FILE_ATTACHMENTS`** **`ENTITIES_LABELS`** **`FILE_ATTACHMENTS`** **`INTENT_OPTIONS`** **`ISSUES`** **`ISSUE_PART_INVENTORIES`** **`LABELS`** **`LOCATIONS`** **`PARTS`** **`PART_INVENTORIES`** **`PART_INVENTORIES_ATTRIBUTES_BASE`** **`PART_INVENTORY_BUILD_REQUIREMENTS`** **`PART_INVENTORY_ROLLED_UP_COSTS`** **`PART_KITS`** **`PART_KIT_INVENTORIES`** **`PART_KIT_ITEMS`** **`PURCHASE_ORDERS`** **`PURCHASE_ORDER_LINES`** **`PURCHASE_ORDER_LINE_INVENTORIES`** **`RECEIPTS`** **`RECEIPT_ITEMS`** **`RUNS`** **`RUN_STEPS`** # PartInventoryHistoryActorTableNameFilter Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryActorTableNameFilter **Kind**: `input` ## Fields **`eq`**: `PartInventoryHistoryActorTableName` --- **`gt`**: `PartInventoryHistoryActorTableName` --- **`gte`**: `PartInventoryHistoryActorTableName` --- **`ilike`**: `PartInventoryHistoryActorTableName` --- **`in`**: `[PartInventoryHistoryActorTableName]` --- **`isnull`**: `Boolean` --- **`like`**: `PartInventoryHistoryActorTableName` --- **`lt`**: `PartInventoryHistoryActorTableName` --- **`lte`**: `PartInventoryHistoryActorTableName` --- **`neq`**: `PartInventoryHistoryActorTableName` --- **`notilike`**: `PartInventoryHistoryActorTableName` --- **`notlike`**: `PartInventoryHistoryActorTableName` # PartInventoryHistoryConnection Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryConnection **Kind**: `object` ## Fields **`edges`**: `[PartInventoryHistoryEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartInventoryHistoryEdge Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryEdge A Relay edge containing a `PartInventoryHistory` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartInventoryHistoryNode` The item at the end of the edge # PartInventoryHistoryInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryInputFilters **Kind**: `input` ## Fields **`actions`**: `PartInventoryHistoryActionInputFilters` --- **`and_`**: `[PartInventoryHistoryNestedInputFilters]` --- **`or_`**: `[PartInventoryHistoryNestedInputFilters]` --- **`tstamp`**: `DateTimeFilter` --- **`userId`**: `IntFilter` # PartInventoryHistoryNestedInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryNestedInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartInventoryHistoryNestedInputFilters]` --- **`or_`**: `[PartInventoryHistoryNestedInputFilters]` --- **`tstamp`**: `DateTimeFilter` --- **`userId`**: `IntFilter` # PartInventoryHistoryNode Source: https://docs.firstresonance.io/api-reference/types/PartInventoryHistoryNode **Kind**: `object` ## Implements - `Node` ## Fields **`actions`**: `[PartInventoryHistoryAction]` **Arguments:** - `filters`: `PartInventoryHistoryActionInputFilters` --- **`id`**: `ID!` --- **`subjectId`**: `Int!` --- **`transactionId`**: `Int!` --- **`tstamp`**: `DateTime!` --- **`user`**: `User` --- **`userId`**: `Int` # PartInventoryQuantity Source: https://docs.firstresonance.io/api-reference/types/PartInventoryQuantity Input object for part_inventory_details in CreateIssueInput. **Kind**: `input` ## Fields **`partInventoryId`**: `Int!` (required) --- **`quantity`**: `Float` Optional. Specifies the amount of inventory to split into a new record.Omitting this selects the entire inventory. # PartInventorySettings Source: https://docs.firstresonance.io/api-reference/types/PartInventorySettings Organization settings related to parts inventory. **Kind**: `object` ## Fields **`allowWipOspKitting`**: `Boolean` If True, WIP inventory linked to a PO line via an outside processing (OSP) run step (isLinkedToOspPoLine) can be added to a kit. --- **`attributes`**: `[AttributeSettings]` --- **`enableInventoryDisposition`**: `Boolean` If True, inventory left behind by a cancellation enters the needs-review queue for a human disposition instead of being released or removed outright. --- **`enforcePlanReservations`**: `Boolean` If True, a plan reservation is a hard claim: the stock it names cannot be kitted or planned onto a pick-run by anyone else. Kitting then treats a terminal plan's reservation as released, while planning still counts it — reconcile before enabling. --- **`mergeInventories`**: `Boolean` --- **`moveInventoryToStepLocation`**: `Boolean` # PartInventorySettingsInput Source: https://docs.firstresonance.io/api-reference/types/PartInventorySettingsInput Organization settings related to parts inventory. **Kind**: `input` ## Fields **`allowWipOspKitting`**: `Boolean` --- **`enableInventoryDisposition`**: `Boolean` --- **`enforcePlanReservations`**: `Boolean` --- **`mergeInventories`**: `Boolean` --- **`moveInventoryToStepLocation`**: `Boolean` # PartInventorySortEnum Source: https://docs.firstresonance.io/api-reference/types/PartInventorySortEnum **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS_COUNT_ASC`** **`ABOM_INSTALLATIONS_COUNT_DESC`** **`ACTIVE_KIT_ID_ASC`** **`ACTIVE_KIT_ID_DESC`** **`AWAITING_REVIEW_ASC`** **`AWAITING_REVIEW_DESC`** **`CANCELED_PO_LINES_COUNT_ASC`** **`CANCELED_PO_LINES_COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`EARLIEST_RUN_ID_ASC`** **`EARLIEST_RUN_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ESTIMATED_ARRIVAL_ASC`** **`ESTIMATED_ARRIVAL_DESC`** **`FAILED_RUNS_COUNT_ASC`** **`FAILED_RUNS_COUNT_DESC`** **`HOW_CREATED_ASC`** **`HOW_CREATED_DESC`** **`HOW_LAST_SPLIT_ASC`** **`HOW_LAST_SPLIT_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`IS_LOCATION_AVAILABLE_ASC`** **`IS_LOCATION_AVAILABLE_DESC`** **`KITTED_ASC`** **`KITTED_DESC`** **`LAST_MAINTAINED_DATE_ASC`** **`LAST_MAINTAINED_DATE_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`LOCATION_NAME_ASC`** **`LOCATION_NAME_DESC`** **`LOT_NUMBER_ASC`** **`LOT_NUMBER_DESC`** **`MADE_ON_ASSEMBLY_PARENT_PART_INVENTORY_ID_ASC`** **`MADE_ON_ASSEMBLY_PARENT_PART_INVENTORY_ID_DESC`** **`MAINTENANCE_STATUS_ASC`** **`MAINTENANCE_STATUS_DESC`** **`MERGE_CANDIDATE_IDS_V2_ASC`** **`MERGE_CANDIDATE_IDS_V2_DESC`** **`NEED_DATE_ASC`** **`NEED_DATE_DESC`** **`OPEN_PO_LINES_COUNT_ASC`** **`OPEN_PO_LINES_COUNT_DESC`** **`OPEN_RUNS_COUNT_ASC`** **`OPEN_RUNS_COUNT_DESC`** **`ORIGIN_MBOM_ID_ASC`** **`ORIGIN_MBOM_ID_DESC`** **`ORIGIN_PART_INVENTORY_ID_ASC`** **`ORIGIN_PART_INVENTORY_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PERCENT_ABOM_INSTALLED_ASC`** **`PERCENT_ABOM_INSTALLED_DESC`** **`PO_LINES_COUNT_ASC`** **`PO_LINES_COUNT_DESC`** **`PROJECTED_RELEASE_STATUS_ASC`** **`PROJECTED_RELEASE_STATUS_DESC`** **`QUALITY_HOLDS_COUNT_ASC`** **`QUALITY_HOLDS_COUNT_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`QUANTITY_INSTALLED_ASC`** **`QUANTITY_INSTALLED_DESC`** **`QUANTITY_KITTED_ASC`** **`QUANTITY_KITTED_DESC`** **`QUANTITY_SCRAPPED_ASC`** **`QUANTITY_SCRAPPED_DESC`** **`RECEIVED_ASC`** **`RECEIVED_DESC`** **`RECEIVED_OR_CREATED_DATE_ASC`** **`RECEIVED_OR_CREATED_DATE_DESC`** **`RECEIVED_PO_LINES_COUNT_ASC`** **`RECEIVED_PO_LINES_COUNT_DESC`** **`SERIAL_NUMBER_ASC`** **`SERIAL_NUMBER_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`SUPPLIER_ID_ASC`** **`SUPPLIER_ID_DESC`** **`UNAVAILABLE_ASC`** **`UNAVAILABLE_DESC`** **`UNIT_OF_MEASURE_ID_ASC`** **`UNIT_OF_MEASURE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`URI_ASC`** **`URI_DESC`** **`_COST_ASC`** **`_COST_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartKit Source: https://docs.firstresonance.io/api-reference/types/PartKit PartKit GraphQL object. **Kind**: `object` ## Fields **`Attributes`**: `[PartKitAttribute]` **Arguments:** - `filters`: `PartKitAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of part kit inventories. --- **`_PartKitItemsCount`**: `Int` Optimized count of partKitItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[PartKitAttributedPart]` **Arguments:** - `filters`: `PartKitAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartKitAttributedUser]` **Arguments:** - `filters`: `PartKitAttributedUsersInputFilters` --- **`attributes`**: `[PartKitAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deliveryLocation`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`deliveryLocationId`**: `Int` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`fillabilityPercent`**: `Int` Share of this kit's remaining need the pick list can allocate, 0-100. Scored for this kit alone: kits picked together in one run share inventory, so a batch can allocate less than the individual scores suggest, and a pick scoped to a locationId can fill less still since this counts stock in every location. Advisory - recalculated when its inputs change, so a concurrent transaction can consume stock this score still counts. The pick list is the authority at allocation time. --- **`fulfilled`**: `Boolean` --- **`id`**: `Int!` --- **`isFullyFillable`**: `Boolean` Whether the pick list can fully allocate this kit's remaining need, scored for this kit alone (see fillabilityPercent). --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`partInventories`**: `[IssuedPartInventory]` --- **`partKitItems`**: `[PartKitItem]` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`percentFulfilled`**: `Int` --- **`percentKitted`**: `Int` --- **`prettyStr`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int` --- **`status`**: `Partkitstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartKitEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PartKitAllocation Source: https://docs.firstresonance.io/api-reference/types/PartKitAllocation How much of one inventory row is allocated to one kit at a pick-list stop. **Kind**: `object` ## Fields **`partKitId`**: `ID` --- **`quantity`**: `Float` # PartKitAttribute Source: https://docs.firstresonance.io/api-reference/types/PartKitAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`partKit`**: `PartKit` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`partKitId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartKitAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PartKitAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`partKitId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PartKitAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartKitAttribute` --- **`oldValues`**: `PartKitAttribute` --- **`timestamp`**: `DateTime` # PartKitAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributedPart Auto-generated GQL type for PartKitAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # PartKitAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartKitAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartKitAttributedPartsInputFilters]` # PartKitAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributedUser Auto-generated GQL type for PartKitAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PartKitAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartKitAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartKitAttributedUsersInputFilters]` # PartKitAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PartKitAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PartKitAttributesInputFilters]` --- **`partKit`**: `PartKitsInputFilters` --- **`partKitId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PartKitEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartKitEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`deliveryLocationId`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fillabilityPercent`**: `IntFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isFullyFillable`**: `BooleanFilter` --- **`locationId`**: `IDFilter` --- **`runId`**: `IDFilter` --- **`status`**: `PartkitstatusenumFilter` --- **`updatedById`**: `IDFilter` # PartKitEvents Source: https://docs.firstresonance.io/api-reference/types/PartKitEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartKit` --- **`oldValues`**: `PartKit` --- **`timestamp`**: `DateTime` # PartKitInventoriesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitInventoriesInputFilters PartKitInventory filterable fields. **Kind**: `input` ## Fields **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartKitInventoriesInputFilters]` --- **`id`**: `IDFilter` --- **`or_`**: `[PartKitInventoriesInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`partKit`**: `PartKitsInputFilters` --- **`partKitItem`**: `PartKitItemsInputFilters` --- **`partKitItemId`**: `IDFilter` --- **`quantity`**: `FloatFilter` # PartKitInventory Source: https://docs.firstresonance.io/api-reference/types/PartKitInventory PartKitInventory GraphQL object. **Kind**: `object` ## Fields **`_MbomItemsCount`**: `Int` Optimized count of mbom items. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`id`**: `ID` --- **`locationId`**: `Int` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`partKit`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`partKitItem`**: `PartKitItem` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKitItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` # PartKitInventorySortEnum Source: https://docs.firstresonance.io/api-reference/types/PartKitInventorySortEnum **Kind**: `enum` ## Values **`ID_ASC`** **`ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PART_KIT_ITEM_ID_ASC`** **`PART_KIT_ITEM_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartKitInventorysConnection Source: https://docs.firstresonance.io/api-reference/types/PartKitInventorysConnection **Kind**: `object` ## Fields **`edges`**: `[PartKitInventorysEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartKitInventorysEdge Source: https://docs.firstresonance.io/api-reference/types/PartKitInventorysEdge A Relay edge containing a `PartKitInventorys` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartKitInventory` The item at the end of the edge # PartKitItem Source: https://docs.firstresonance.io/api-reference/types/PartKitItem PartKitItem GraphQL object. **Kind**: `object` ## Fields **`Attributes`**: `[PartKitItemAttribute]` **Arguments:** - `filters`: `PartKitItemAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartKitInventoriesCount`**: `Int` Optimized count of partKitInventories. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`acceptablePartIds`**: `[PartKitItemAcceptablePart]` --- **`attributedParts`**: `[PartKitItemAttributedPart]` **Arguments:** - `filters`: `PartKitItemAttributedPartsInputFilters` --- **`attributedUsers`**: `[PartKitItemAttributedUser]` **Arguments:** - `filters`: `PartKitItemAttributedUsersInputFilters` --- **`attributes`**: `[PartKitItemAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`firstInventoryDisplay`**: `String` Get first inventory to display on Kitting page. This is not very performant and should only be used on the Kitting page. **Arguments:** - `includeOnOrder`: `Boolean!` --- **`fulfilled`**: `Boolean` --- **`id`**: `Int!` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`originMbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`originMbomItemId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`partInventories`**: `[IssuedPartInventory]` --- **`partKit`**: `PartKit` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`partKitId`**: `Int` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`quantityFulfilled`**: `Float` --- **`quantityUnfulfilled`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartKitItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PartKitItemAcceptablePart Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAcceptablePart Acceptable part_id, and relationship type to part_kit_item. **Kind**: `object` ## Fields **`partId`**: `Int` --- **`partIdInformation`**: `String` # PartKitItemAttribute Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`partKitItem`**: `PartKitItem` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKitItemId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartKitItemAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PartKitItemAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`partKitItemId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PartKitItemAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartKitItemAttribute` --- **`oldValues`**: `PartKitItemAttribute` --- **`timestamp`**: `DateTime` # PartKitItemAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributedPart Auto-generated GQL type for PartKitItemAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # PartKitItemAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartKitItemAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartKitItemAttributedPartsInputFilters]` # PartKitItemAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributedUser Auto-generated GQL type for PartKitItemAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PartKitItemAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PartKitItemAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PartKitItemAttributedUsersInputFilters]` # PartKitItemAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitItemAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PartKitItemAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PartKitItemAttributesInputFilters]` --- **`partKitItem`**: `PartKitItemsInputFilters` --- **`partKitItemId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PartKitItemEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartKitItemEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`originMbomItemId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`partKitId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedById`**: `IDFilter` # PartKitItemEvents Source: https://docs.firstresonance.io/api-reference/types/PartKitItemEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartKitItem` --- **`oldValues`**: `PartKitItem` --- **`timestamp`**: `DateTime` # PartKitItemSettings Source: https://docs.firstresonance.io/api-reference/types/PartKitItemSettings Organization settings related to part kit items. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` # PartKitItemSortEnum Source: https://docs.firstresonance.io/api-reference/types/PartKitItemSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`ORIGIN_MBOM_ITEM_ID_ASC`** **`ORIGIN_MBOM_ITEM_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PART_KIT_ID_ASC`** **`PART_KIT_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartKitItemsConnection Source: https://docs.firstresonance.io/api-reference/types/PartKitItemsConnection **Kind**: `object` ## Fields **`edges`**: `[PartKitItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartKitItemsEdge Source: https://docs.firstresonance.io/api-reference/types/PartKitItemsEdge A Relay edge containing a `PartKitItems` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartKitItem` The item at the end of the edge # PartKitItemsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitItemsInputFilters PartKitItem filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartKitItemsInputFilters]` --- **`attributedParts`**: `PartKitItemAttributedPartsInputFilters` --- **`attributedUsers`**: `PartKitItemAttributedUsersInputFilters` --- **`attributes`**: `PartKitItemAttributesInputFilters` --- **`comments`**: `CommentsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`fulfilled`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`labels`**: `LabelsInputFilters` --- **`or_`**: `[PartKitItemsInputFilters]` --- **`originMbomItem`**: `MBomItemsInputFilters` --- **`originMbomItemId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partKit`**: `PartKitsInputFilters` --- **`partKitId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`quantityFulfilled`**: `FloatFilter` --- **`quantityUnfulfilled`**: `FloatFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PartKitPickList Source: https://docs.firstresonance.io/api-reference/types/PartKitPickList PartKitPickList GraphQL object - supports single or multi-kit pick lists. **Kind**: `object` ## Fields **`locations`**: `[PartKitPickListLocation]` --- **`partInventories`**: `[PartInventory]` # PartKitPickListInventoryRow Source: https://docs.firstresonance.io/api-reference/types/PartKitPickListInventoryRow An inventory row in a location stop, with its per-kit split. **Kind**: `object` ## Fields **`inventory`**: `PartInventory` --- **`inventoryId`**: `ID` --- **`kitAllocations`**: `[PartKitAllocation]` --- **`partId`**: `ID` --- **`quantityToPull`**: `Float` # PartKitPickListLocation Source: https://docs.firstresonance.io/api-reference/types/PartKitPickListLocation A location stop in the pick list with its inventory rows. **Kind**: `object` ## Fields **`inventoryRows`**: `[PartKitPickListInventoryRow]` --- **`locationId`**: `ID` --- **`locationName`**: `String` --- **`stopNumber`**: `Int` # PartKitSettings Source: https://docs.firstresonance.io/api-reference/types/PartKitSettings Organization settings related to part kits. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`restrictInstallToAssignedRun`**: `Boolean` # PartKitSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PartKitSettingsInput Input settings related to part kits. **Kind**: `input` ## Fields **`restrictInstallToAssignedRun`**: `Boolean` # PartKitSortEnum Source: https://docs.firstresonance.io/api-reference/types/PartKitSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DELIVERY_LOCATION_ID_ASC`** **`DELIVERY_LOCATION_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FILLABILITY_PERCENT_ASC`** **`FILLABILITY_PERCENT_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_FULLY_FILLABLE_ASC`** **`IS_FULLY_FILLABLE_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`RUN_ID_ASC`** **`RUN_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartKitsConnection Source: https://docs.firstresonance.io/api-reference/types/PartKitsConnection **Kind**: `object` ## Fields **`edges`**: `[PartKitsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartKitsEdge Source: https://docs.firstresonance.io/api-reference/types/PartKitsEdge A Relay edge containing a `PartKits` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartKit` The item at the end of the edge # PartKitsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartKitsInputFilters PartKit filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartKitsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`attributedParts`**: `PartKitAttributedPartsInputFilters` --- **`attributedUsers`**: `PartKitAttributedUsersInputFilters` --- **`attributes`**: `PartKitAttributesInputFilters` --- **`comments`**: `CommentsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`deliveryLocation`**: `LocationsInputFilters` --- **`deliveryLocationId`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`fillabilityPercent`**: `IntFilter` --- **`fulfilled`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`isFullyFillable`**: `BooleanFilter` --- **`labels`**: `LabelsInputFilters` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`or_`**: `[PartKitsInputFilters]` --- **`partKitItems`**: `PartKitItemsInputFilters` --- **`percentFulfilled`**: `IntFilter` --- **`percentKitted`**: `IntFilter` --- **`run`**: `RunsInputFilters` --- **`runId`**: `IDFilter` --- **`status`**: `PartkitstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PartProcedure Source: https://docs.firstresonance.io/api-reference/types/PartProcedure A Part related to a Run or Procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `ID!` --- **`pinnedMbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`pinnedMbomId`**: `Int` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `ID!` --- **`required`**: `Boolean!` --- **`status`**: `partprocedurestatusreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartProcedureEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PartProcedureEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartProcedureEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partId`**: `IDFilter` --- **`pinnedMbomId`**: `IDFilter` --- **`procedureId`**: `IDFilter` --- **`required`**: `BooleanFilter` --- **`status`**: `partprocedurestatusreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # PartProcedureEvents Source: https://docs.firstresonance.io/api-reference/types/PartProcedureEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartProcedure` --- **`oldValues`**: `PartProcedure` --- **`timestamp`**: `DateTime` # PartProcedureSortEnum Source: https://docs.firstresonance.io/api-reference/types/PartProcedureSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PINNED_MBOM_ID_ASC`** **`PINNED_MBOM_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`REQUIRED_ASC`** **`REQUIRED_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartProceduresConnection Source: https://docs.firstresonance.io/api-reference/types/PartProceduresConnection **Kind**: `object` ## Fields **`edges`**: `[PartProceduresEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartProceduresEdge Source: https://docs.firstresonance.io/api-reference/types/PartProceduresEdge A Relay edge containing a `PartProcedures` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartProcedure` The item at the end of the edge # PartProceduresInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartProceduresInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartProceduresInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[PartProceduresInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`pinnedMbom`**: `MBomsInputFilters` --- **`pinnedMbomId`**: `IDFilter` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`required`**: `BooleanFilter` --- **`status`**: `partprocedurestatusreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PartQualityCheckSettings Source: https://docs.firstresonance.io/api-reference/types/PartQualityCheckSettings Settings for part_quality_check policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` --- **`mode`**: `String` # PartQualityCheckSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PartQualityCheckSettingsInput Input for part_quality_check policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`mode`**: `String` # PartRevisionSchemeSettings Source: https://docs.firstresonance.io/api-reference/types/PartRevisionSchemeSettings Organization settings for part revision format and restrictions. **Kind**: `object` ## Fields **`allowOverflow`**: `Boolean` --- **`default`**: `Boolean` --- **`format`**: `[String]` --- **`name`**: `String` # PartSettings Source: https://docs.firstresonance.io/api-reference/types/PartSettings Organization settings related to parts. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`globalUniqueSerialNumbers`**: `[GlobalUniqueSerialNumberSchemeSettings]` --- **`partInterchangeability`**: `Boolean` --- **`revisionSchemes`**: `[PartRevisionSchemeSettings]` # PartSortEnum Source: https://docs.firstresonance.io/api-reference/types/PartSortEnum **Kind**: `enum` ## Values **`COST_ASC`** **`COST_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEMAND_TOTAL_ASC`** **`DEMAND_TOTAL_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`HAS_INVENTORY_ASC`** **`HAS_INVENTORY_DESC`** **`ID_ASC`** **`ID_DESC`** **`INDEPENDENT_DEMAND_TOTAL_ASC`** **`INDEPENDENT_DEMAND_TOTAL_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`LEAD_TIME_ASC`** **`LEAD_TIME_DESC`** **`MAINTENANCE_INTERVAL_SECONDS_ASC`** **`MAINTENANCE_INTERVAL_SECONDS_DESC`** **`PART_NUMBER_ASC`** **`PART_NUMBER_DESC`** **`PART_TYPE_ASC`** **`PART_TYPE_DESC`** **`PURCHASE_TYPE_ASC`** **`PURCHASE_TYPE_DESC`** **`REORDER_MAXIMUM_QUANTITY_ASC`** **`REORDER_MAXIMUM_QUANTITY_DESC`** **`REORDER_MINIMUM_QUANTITY_ASC`** **`REORDER_MINIMUM_QUANTITY_DESC`** **`REVISED_FROM_ID_ASC`** **`REVISED_FROM_ID_DESC`** **`REVISION_ASC`** **`REVISION_DESC`** **`REVISION_SCHEME_ASC`** **`REVISION_SCHEME_DESC`** **`SOURCING_STRATEGY_ASC`** **`SOURCING_STRATEGY_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`SUPPLIER_PART_NUMBER_ASC`** **`SUPPLIER_PART_NUMBER_DESC`** **`SURPLUS_TOTAL_ASC`** **`SURPLUS_TOTAL_DESC`** **`THUMBNAIL_ID_ASC`** **`THUMBNAIL_ID_DESC`** **`TRACKING_TYPE_ASC`** **`TRACKING_TYPE_DESC`** **`UNIT_OF_MEASURE_ID_ASC`** **`UNIT_OF_MEASURE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_EXPORT_CONTROLLED_ASC`** **`_EXPORT_CONTROLLED_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartSubtype Source: https://docs.firstresonance.io/api-reference/types/PartSubtype A PartSubtype related to a Part. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_PartsCount`**: `Int` Optimized count of parts. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`parts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartSubtypeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PartSubtypeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartSubtypeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`updatedById`**: `IDFilter` # PartSubtypeEvents Source: https://docs.firstresonance.io/api-reference/types/PartSubtypeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartSubtype` --- **`oldValues`**: `PartSubtype` --- **`timestamp`**: `DateTime` # PartSubtypeSortEnum Source: https://docs.firstresonance.io/api-reference/types/PartSubtypeSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PartSubtypeToPartInput Source: https://docs.firstresonance.io/api-reference/types/PartSubtypeToPartInput Input object relating a part subtype to a part through part subtype id. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`partId`**: `Int!` (required) --- **`partSubtypeId`**: `Int!` (required) # PartSubtypesConnection Source: https://docs.firstresonance.io/api-reference/types/PartSubtypesConnection **Kind**: `object` ## Fields **`edges`**: `[PartSubtypesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartSubtypesEdge Source: https://docs.firstresonance.io/api-reference/types/PartSubtypesEdge A Relay edge containing a `PartSubtypes` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartSubtype` The item at the end of the edge # PartSubtypesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartSubtypesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartSubtypesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[PartSubtypesInputFilters]` --- **`parts`**: `PartsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PartUnitOfMeasureConflict Source: https://docs.firstresonance.io/api-reference/types/PartUnitOfMeasureConflict A UoM conflict between parts through mBOM substitutes or part interchangeability. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`conflictPart`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`conflictPartId`**: `Int!` --- **`conflictType`**: `Partconflicttypeenum` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomPart`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`mbomPartId`**: `Int` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PartUnitOfMeasureConflictEventFilter` # PartUnitOfMeasureConflictEventFilter Source: https://docs.firstresonance.io/api-reference/types/PartUnitOfMeasureConflictEventFilter **Kind**: `input` ## Fields **`actor`**: `UserInputFilters` --- **`conflictPartId`**: `IDFilter` --- **`conflictType`**: `PartconflicttypeenumFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mbomPartId`**: `IDFilter` --- **`partId`**: `IDFilter` # PartUnitOfMeasureConflictEvents Source: https://docs.firstresonance.io/api-reference/types/PartUnitOfMeasureConflictEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PartUnitOfMeasureConflict` --- **`oldValues`**: `PartUnitOfMeasureConflict` --- **`timestamp`**: `DateTime` # Partconflicttypeenum Source: https://docs.firstresonance.io/api-reference/types/Partconflicttypeenum **Kind**: `enum` ## Values **`INTERCHANGEABLE_PART`** **`MBOM_SUBSTITUTE`** # PartconflicttypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/PartconflicttypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Partconflicttypeenum` --- **`gt`**: `Partconflicttypeenum` --- **`gte`**: `Partconflicttypeenum` --- **`ilike`**: `Partconflicttypeenum` --- **`in`**: `[Partconflicttypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Partconflicttypeenum` --- **`lt`**: `Partconflicttypeenum` --- **`lte`**: `Partconflicttypeenum` --- **`neq`**: `Partconflicttypeenum` --- **`notilike`**: `Partconflicttypeenum` --- **`notlike`**: `Partconflicttypeenum` # Partkitstatusenum Source: https://docs.firstresonance.io/api-reference/types/Partkitstatusenum **Kind**: `enum` ## Values **`CANCELED`** **`COMPLETED`** **`DELIVERED`** **`DRAFT`** **`IN_PROGRESS`** **`REQUESTED`** # PartkitstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PartkitstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Partkitstatusenum` --- **`gt`**: `Partkitstatusenum` --- **`gte`**: `Partkitstatusenum` --- **`ilike`**: `Partkitstatusenum` --- **`in`**: `[Partkitstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Partkitstatusenum` --- **`lt`**: `Partkitstatusenum` --- **`lte`**: `Partkitstatusenum` --- **`neq`**: `Partkitstatusenum` --- **`notilike`**: `Partkitstatusenum` --- **`notlike`**: `Partkitstatusenum` # PartsConnection Source: https://docs.firstresonance.io/api-reference/types/PartsConnection **Kind**: `object` ## Fields **`edges`**: `[PartsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PartsEdge Source: https://docs.firstresonance.io/api-reference/types/PartsEdge A Relay edge containing a `Parts` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Part` The item at the end of the edge # PartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PartsInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`MbomItemSubstitutes`**: `MBomSubstituteInputFilters` --- **`MbomItems`**: `MBomItemsInputFilters` --- **`_created`**: `DateTimeFilter` --- **`_latest_revision_scheme`**: `StringFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PartsInputFilters]` --- **`attributedParts`**: `PartAttributedPartsInputFilters` --- **`attributedUsers`**: `PartAttributedUsersInputFilters` --- **`attributes`**: `PartAttributesInputFilters` --- **`buildRequirementSubstitutes`**: `BuildRequirementSubstitutesInputFilters` --- **`buildRequirements`**: `BuildRequirementsInputFilters` --- **`cost`**: `FloatFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`demandTotal`**: `FloatFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`exportControlled`**: `BooleanFilter` --- **`furtherActions`**: `FurtherActionsInputFilters` --- **`hasInventory`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`independentDemandTotal`**: `FloatFilter` --- **`inputs`**: `PlanInputsInputFilters` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IDFilter` --- **`isLatestRevision`**: `BooleanFilter` --- **`labels`**: `LabelsInputFilters` --- **`latestRevision`**: `StringFilter` --- **`leadTime`**: `IntFilter` --- **`maintenanceIntervalSeconds`**: `IntFilter` --- **`mboms`**: `MBomsInputFilters` --- **`or_`**: `[PartsInputFilters]` --- **`partKitItems`**: `PartKitItemsInputFilters` --- **`partNumber`**: `StringFilter` --- **`partProcedures`**: `PartProceduresInputFilters` --- **`partSubtypes`**: `PartSubtypesInputFilters` --- **`partType`**: `ParttypeenumFilter` --- **`partsInventory`**: `PartInventoriesInputFilters` --- **`planItems`**: `PlanItemsInputFilters` --- **`procedures`**: `ProceduresInputFilters` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`purchaseType`**: `purchasetypeenumFilter` --- **`reorderMaximumQuantity`**: `FloatFilter` --- **`reorderMinimumQuantity`**: `FloatFilter` --- **`requirements`**: `RequirementsInputFilters` --- **`revisedFromId`**: `IDFilter` --- **`revision`**: `StringFilter` --- **`revisionScheme`**: `StringFilter` --- **`runs`**: `RunsInputFilters` --- **`sourcingStrategy`**: `SourcingstrategyenumFilter` --- **`status`**: `PartstatusenumFilter` --- **`supplierPartNumber`**: `StringFilter` --- **`supplierParts`**: `SupplierPartsInputFilters` --- **`surplusTotal`**: `FloatFilter` --- **`thumbnail`**: `FileAttachmentsInputFilters` --- **`thumbnailId`**: `IDFilter` --- **`trackingType`**: `TrackingtypeenumFilter` --- **`unitOfMeasure`**: `UnitsOfMeasurementInputFilters` --- **`unitOfMeasureId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PartsSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PartsSettingsInput Organization settings related to parts. Covers a subset of them. **Kind**: `input` ## Fields **`partInterchangeability`**: `Boolean` # Partstatusenum Source: https://docs.firstresonance.io/api-reference/types/Partstatusenum **Kind**: `enum` ## Values **`ARCHIVED`** **`RELEASED`** # PartstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PartstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Partstatusenum` --- **`gt`**: `Partstatusenum` --- **`gte`**: `Partstatusenum` --- **`ilike`**: `Partstatusenum` --- **`in`**: `[Partstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Partstatusenum` --- **`lt`**: `Partstatusenum` --- **`lte`**: `Partstatusenum` --- **`neq`**: `Partstatusenum` --- **`notilike`**: `Partstatusenum` --- **`notlike`**: `Partstatusenum` # Parttypeenum Source: https://docs.firstresonance.io/api-reference/types/Parttypeenum **Kind**: `enum` ## Values **`PART`** **`TOOL`** # ParttypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/ParttypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Parttypeenum` --- **`gt`**: `Parttypeenum` --- **`gte`**: `Parttypeenum` --- **`ilike`**: `Parttypeenum` --- **`in`**: `[Parttypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Parttypeenum` --- **`lt`**: `Parttypeenum` --- **`lte`**: `Parttypeenum` --- **`neq`**: `Parttypeenum` --- **`notilike`**: `Parttypeenum` --- **`notlike`**: `Parttypeenum` # PermissionGroup Source: https://docs.firstresonance.io/api-reference/types/PermissionGroup GraphQL object. **Kind**: `object` ## Fields **`_RolesCount`**: `Int` Optimized count of roles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`family`**: `String!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PermissionGroupEventFilter` # PermissionGroupEventFilter Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`family`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` # PermissionGroupEvents Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PermissionGroup` --- **`oldValues`**: `PermissionGroup` --- **`timestamp`**: `DateTime` # PermissionGroupSortEnum Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupSortEnum **Kind**: `enum` ## Values **`FAMILY_ASC`** **`FAMILY_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PermissionGroupToRoleInput Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupToRoleInput Inputs needed to associate a permission group to a role. **Kind**: `input` ## Fields **`permissionGroupId`**: `Int!` (required) --- **`roleId`**: `Int!` (required) # PermissionGroupsConnection Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupsConnection **Kind**: `object` ## Fields **`edges`**: `[PermissionGroupsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PermissionGroupsEdge Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupsEdge A Relay edge containing a `PermissionGroups` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PermissionGroup` The item at the end of the edge # PermissionGroupsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PermissionGroupsInputFilters **Kind**: `input` ## Fields **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PermissionGroupsInputFilters]` --- **`family`**: `StringFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[PermissionGroupsInputFilters]` --- **`roles`**: `RolesInputFilters` # PickListStrategy Source: https://docs.firstresonance.io/api-reference/types/PickListStrategy Enum of pick list strategies. **Kind**: `enum` ## Values **`FIFO`** # PickOverrideEvent Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEvent A recorded divergence between a recommended pick and the actual pick. Append-only telemetry: create and list only. Nothing edits or deletes an override after the fact. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_updated`**: `DateTime` --- **`chosenLocationId`**: `Int` --- **`chosenPartId`**: `Int` --- **`chosenPartInventoryId`**: `Int!` --- **`createdById`**: `Int!` --- **`id`**: `ID!` --- **`occurredAt`**: `DateTime!` --- **`partId`**: `Int!` --- **`partKitId`**: `Int!` --- **`pickRunStop`**: `PickRunStop` **Arguments:** - `filters`: `PickRunStopsInputFilters` --- **`pickRunStopId`**: `Int` --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`reason`**: `Pickoverridereasonenum` --- **`reasonText`**: `String` --- **`recommendedLocationId`**: `Int` --- **`recommendedPartInventoryId`**: `Int!` --- **`surface`**: `Pickoverridesurfaceenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PickOverrideEventEventFilter` # PickOverrideEventEventFilter Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEventEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`chosenLocationId`**: `IntFilter` --- **`chosenPartId`**: `IDFilter` --- **`chosenPartInventoryId`**: `IntFilter` --- **`createdById`**: `IntFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`occurredAt`**: `DateTimeFilter` --- **`partId`**: `IDFilter` --- **`partKitId`**: `IntFilter` --- **`pickRunStopId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`reason`**: `PickoverridereasonenumFilter` --- **`reasonText`**: `StringFilter` --- **`recommendedLocationId`**: `IntFilter` --- **`recommendedPartInventoryId`**: `IntFilter` --- **`surface`**: `PickoverridesurfaceenumFilter` # PickOverrideEventEvents Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEventEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PickOverrideEvent` --- **`oldValues`**: `PickOverrideEvent` --- **`timestamp`**: `DateTime` # PickOverrideEventSortEnum Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEventSortEnum **Kind**: `enum` ## Values **`CHOSEN_LOCATION_ID_ASC`** **`CHOSEN_LOCATION_ID_DESC`** **`CHOSEN_PART_ID_ASC`** **`CHOSEN_PART_ID_DESC`** **`CHOSEN_PART_INVENTORY_ID_ASC`** **`CHOSEN_PART_INVENTORY_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`OCCURRED_AT_ASC`** **`OCCURRED_AT_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PART_KIT_ID_ASC`** **`PART_KIT_ID_DESC`** **`PICK_RUN_STOP_ID_ASC`** **`PICK_RUN_STOP_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`REASON_ASC`** **`REASON_DESC`** **`REASON_TEXT_ASC`** **`REASON_TEXT_DESC`** **`RECOMMENDED_LOCATION_ID_ASC`** **`RECOMMENDED_LOCATION_ID_DESC`** **`RECOMMENDED_PART_INVENTORY_ID_ASC`** **`RECOMMENDED_PART_INVENTORY_ID_DESC`** **`SURFACE_ASC`** **`SURFACE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PickOverrideEventsConnection Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEventsConnection **Kind**: `object` ## Fields **`edges`**: `[PickOverrideEventsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PickOverrideEventsEdge Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEventsEdge A Relay edge containing a `PickOverrideEvents` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PickOverrideEvent` The item at the end of the edge # PickOverrideEventsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PickOverrideEventsInputFilters PickOverrideEvent filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PickOverrideEventsInputFilters]` --- **`chosenLocationId`**: `IntFilter` --- **`chosenPartId`**: `IDFilter` --- **`chosenPartInventoryId`**: `IntFilter` --- **`createdById`**: `IntFilter` --- **`id`**: `IDFilter` --- **`occurredAt`**: `DateTimeFilter` --- **`or_`**: `[PickOverrideEventsInputFilters]` --- **`partId`**: `IDFilter` --- **`partKitId`**: `IntFilter` --- **`pickRunStop`**: `PickRunStopsInputFilters` --- **`pickRunStopId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`reason`**: `PickoverridereasonenumFilter` --- **`reasonText`**: `StringFilter` --- **`recommendedLocationId`**: `IntFilter` --- **`recommendedPartInventoryId`**: `IntFilter` --- **`surface`**: `PickoverridesurfaceenumFilter` # PickRun Source: https://docs.firstresonance.io/api-reference/types/PickRun A persisted, resumable walk over one or more kits. **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_KitsCount`**: `Int` Optimized count of kits. --- **`_StopsCount`**: `Int` Optimized count of stops. --- **`closedAt`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`expiresAt`**: `DateTime!` --- **`id`**: `ID!` --- **`isBatchPick`**: `Boolean!` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`prettyStr`**: `String` --- **`progress`**: `PickRunProgress` --- **`status`**: `Pickrunstatusenum!` --- **`stops`**: `[PickRunStop]` **Arguments:** - `filters`: `PickRunStopsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PickRunEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PickRunEventFilter Source: https://docs.firstresonance.io/api-reference/types/PickRunEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`closedAt`**: `DateTimeFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`expiresAt`**: `DateTimeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isBatchPick`**: `BooleanFilter` --- **`locationId`**: `IDFilter` --- **`status`**: `PickrunstatusenumFilter` --- **`updatedById`**: `IDFilter` # PickRunEvents Source: https://docs.firstresonance.io/api-reference/types/PickRunEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PickRun` --- **`oldValues`**: `PickRun` --- **`timestamp`**: `DateTime` # PickRunProgress Source: https://docs.firstresonance.io/api-reference/types/PickRunProgress How far through the walk the picker is. Units are picked quantity, not allocated; a stop can be done having pulled less than planned. **Kind**: `object` ## Fields **`pickRunId`**: `ID!` --- **`stopsDone`**: `Int` --- **`stopsTotal`**: `Int` --- **`unitsPicked`**: `Float` --- **`unitsTotal`**: `Float` # PickRunSettings Source: https://docs.firstresonance.io/api-reference/types/PickRunSettings Settings related to pick runs. **Kind**: `object` ## Fields **`expiryHours`**: `Int` # PickRunSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PickRunSettingsInput Input settings related to pick runs. **Kind**: `input` ## Fields **`expiryHours`**: `Int` # PickRunSortEnum Source: https://docs.firstresonance.io/api-reference/types/PickRunSortEnum **Kind**: `enum` ## Values **`CLOSED_AT_ASC`** **`CLOSED_AT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`EXPIRES_AT_ASC`** **`EXPIRES_AT_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_BATCH_PICK_ASC`** **`IS_BATCH_PICK_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PickRunStop Source: https://docs.firstresonance.io/api-reference/types/PickRunStop One bin visit in the walk. **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_AllocationsCount`**: `Int` Optimized count of allocations. --- **`allocations`**: `[PickRunStopAllocation]` **Arguments:** - `filters`: `PickRunStopAllocationsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID!` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`pickRun`**: `PickRun` **Arguments:** - `filters`: `PickRunsInputFilters` --- **`pickRunId`**: `Int!` --- **`prettyStr`**: `String` --- **`scannedAt`**: `DateTime` --- **`scannedById`**: `Int` --- **`scannedPartInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`scannedPartInventoryId`**: `Int` --- **`status`**: `Pickrunstopstatusenum!` --- **`stopSequence`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PickRunStopEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PickRunStopAllocation Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocation One kit's claim on one inventory row at a stop. **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID!` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int!` --- **`partKit`**: `PartKit` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`partKitId`**: `Int!` --- **`partKitItem`**: `PartKitItem` **Arguments:** - `filters`: `PartKitItemsInputFilters` --- **`partKitItemId`**: `Int!` --- **`pickRunStopId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantityAllocated`**: `Float!` --- **`quantityPicked`**: `Float!` --- **`status`**: `Pickrunallocationstatusenum!` --- **`stop`**: `PickRunStop` **Arguments:** - `filters`: `PickRunStopsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PickRunStopAllocationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PickRunStopAllocationEventFilter Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partInventoryId`**: `IDFilter` --- **`partKitId`**: `IDFilter` --- **`partKitItemId`**: `IDFilter` --- **`pickRunStopId`**: `IDFilter` --- **`quantityAllocated`**: `FloatFilter` --- **`quantityPicked`**: `FloatFilter` --- **`status`**: `PickrunallocationstatusenumFilter` --- **`updatedById`**: `IDFilter` # PickRunStopAllocationEvents Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PickRunStopAllocation` --- **`oldValues`**: `PickRunStopAllocation` --- **`timestamp`**: `DateTime` # PickRunStopAllocationSortEnum Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocationSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PART_KIT_ID_ASC`** **`PART_KIT_ID_DESC`** **`PART_KIT_ITEM_ID_ASC`** **`PART_KIT_ITEM_ID_DESC`** **`PICK_RUN_STOP_ID_ASC`** **`PICK_RUN_STOP_ID_DESC`** **`QUANTITY_ALLOCATED_ASC`** **`QUANTITY_ALLOCATED_DESC`** **`QUANTITY_PICKED_ASC`** **`QUANTITY_PICKED_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PickRunStopAllocationsConnection Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocationsConnection **Kind**: `object` ## Fields **`edges`**: `[PickRunStopAllocationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PickRunStopAllocationsEdge Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocationsEdge A Relay edge containing a `PickRunStopAllocations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PickRunStopAllocation` The item at the end of the edge # PickRunStopAllocationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PickRunStopAllocationsInputFilters PickRunStopAllocation filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PickRunStopAllocationsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[PickRunStopAllocationsInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`partKit`**: `PartKitsInputFilters` --- **`partKitId`**: `IDFilter` --- **`partKitItem`**: `PartKitItemsInputFilters` --- **`partKitItemId`**: `IDFilter` --- **`pickRunStopId`**: `IDFilter` --- **`quantityAllocated`**: `FloatFilter` --- **`quantityPicked`**: `FloatFilter` --- **`status`**: `PickrunallocationstatusenumFilter` --- **`stop`**: `PickRunStopsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PickRunStopConfirmationInput Source: https://docs.firstresonance.io/api-reference/types/PickRunStopConfirmationInput What actually came off the shelf for one planned split. `part_inventory_id` names the lot that actually satisfied the split. Omit it and the planned lot is assumed; supply a different one and the pick is a substitution, recorded on the allocation itself rather than settled at zero and issued through a second mutation. **Kind**: `input` ## Fields **`allocationId`**: `ID!` (required) --- **`partInventoryId`**: `ID` --- **`quantityPicked`**: `Float!` (required) # PickRunStopEventFilter Source: https://docs.firstresonance.io/api-reference/types/PickRunStopEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`locationId`**: `IDFilter` --- **`pickRunId`**: `IDFilter` --- **`scannedAt`**: `DateTimeFilter` --- **`scannedById`**: `IDFilter` --- **`scannedPartInventoryId`**: `IDFilter` --- **`status`**: `PickrunstopstatusenumFilter` --- **`stopSequence`**: `IntFilter` --- **`updatedById`**: `IDFilter` # PickRunStopEvents Source: https://docs.firstresonance.io/api-reference/types/PickRunStopEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PickRunStop` --- **`oldValues`**: `PickRunStop` --- **`timestamp`**: `DateTime` # PickRunStopSortEnum Source: https://docs.firstresonance.io/api-reference/types/PickRunStopSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`PICK_RUN_ID_ASC`** **`PICK_RUN_ID_DESC`** **`SCANNED_AT_ASC`** **`SCANNED_AT_DESC`** **`SCANNED_BY_ID_ASC`** **`SCANNED_BY_ID_DESC`** **`SCANNED_PART_INVENTORY_ID_ASC`** **`SCANNED_PART_INVENTORY_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STOP_SEQUENCE_ASC`** **`STOP_SEQUENCE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PickRunStopsConnection Source: https://docs.firstresonance.io/api-reference/types/PickRunStopsConnection **Kind**: `object` ## Fields **`edges`**: `[PickRunStopsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PickRunStopsEdge Source: https://docs.firstresonance.io/api-reference/types/PickRunStopsEdge A Relay edge containing a `PickRunStops` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PickRunStop` The item at the end of the edge # PickRunStopsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PickRunStopsInputFilters PickRunStop filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allocations`**: `PickRunStopAllocationsInputFilters` --- **`and_`**: `[PickRunStopsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`or_`**: `[PickRunStopsInputFilters]` --- **`pickRun`**: `PickRunsInputFilters` --- **`pickRunId`**: `IDFilter` --- **`scannedAt`**: `DateTimeFilter` --- **`scannedById`**: `IDFilter` --- **`scannedPartInventory`**: `PartInventoriesInputFilters` --- **`scannedPartInventoryId`**: `IDFilter` --- **`status`**: `PickrunstopstatusenumFilter` --- **`stopSequence`**: `IntFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PickRunsConnection Source: https://docs.firstresonance.io/api-reference/types/PickRunsConnection **Kind**: `object` ## Fields **`edges`**: `[PickRunsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PickRunsEdge Source: https://docs.firstresonance.io/api-reference/types/PickRunsEdge A Relay edge containing a `PickRuns` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PickRun` The item at the end of the edge # PickRunsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PickRunsInputFilters PickRun filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PickRunsInputFilters]` --- **`closedAt`**: `DateTimeFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`expiresAt`**: `DateTimeFilter` --- **`id`**: `IDFilter` --- **`isBatchPick`**: `BooleanFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`or_`**: `[PickRunsInputFilters]` --- **`status`**: `PickrunstatusenumFilter` --- **`stops`**: `PickRunStopsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Pickoverridereasonenum Source: https://docs.firstresonance.io/api-reference/types/Pickoverridereasonenum **Kind**: `enum` ## Values **`CLOSER_BIN`** **`DAMAGED`** **`OTHER`** **`WRONG_QTY`** # PickoverridereasonenumFilter Source: https://docs.firstresonance.io/api-reference/types/PickoverridereasonenumFilter **Kind**: `input` ## Fields **`eq`**: `Pickoverridereasonenum` --- **`gt`**: `Pickoverridereasonenum` --- **`gte`**: `Pickoverridereasonenum` --- **`ilike`**: `Pickoverridereasonenum` --- **`in`**: `[Pickoverridereasonenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Pickoverridereasonenum` --- **`lt`**: `Pickoverridereasonenum` --- **`lte`**: `Pickoverridereasonenum` --- **`neq`**: `Pickoverridereasonenum` --- **`notilike`**: `Pickoverridereasonenum` --- **`notlike`**: `Pickoverridereasonenum` # Pickoverridesurfaceenum Source: https://docs.firstresonance.io/api-reference/types/Pickoverridesurfaceenum **Kind**: `enum` ## Values **`KITTING_BATCH`** **`PICK_RUN`** **`PICK_RUN_SCAN`** # PickoverridesurfaceenumFilter Source: https://docs.firstresonance.io/api-reference/types/PickoverridesurfaceenumFilter **Kind**: `input` ## Fields **`eq`**: `Pickoverridesurfaceenum` --- **`gt`**: `Pickoverridesurfaceenum` --- **`gte`**: `Pickoverridesurfaceenum` --- **`ilike`**: `Pickoverridesurfaceenum` --- **`in`**: `[Pickoverridesurfaceenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Pickoverridesurfaceenum` --- **`lt`**: `Pickoverridesurfaceenum` --- **`lte`**: `Pickoverridesurfaceenum` --- **`neq`**: `Pickoverridesurfaceenum` --- **`notilike`**: `Pickoverridesurfaceenum` --- **`notlike`**: `Pickoverridesurfaceenum` # Pickrunallocationstatusenum Source: https://docs.firstresonance.io/api-reference/types/Pickrunallocationstatusenum **Kind**: `enum` ## Values **`PENDING`** **`PICKED`** **`SKIPPED`** # PickrunallocationstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PickrunallocationstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Pickrunallocationstatusenum` --- **`gt`**: `Pickrunallocationstatusenum` --- **`gte`**: `Pickrunallocationstatusenum` --- **`ilike`**: `Pickrunallocationstatusenum` --- **`in`**: `[Pickrunallocationstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Pickrunallocationstatusenum` --- **`lt`**: `Pickrunallocationstatusenum` --- **`lte`**: `Pickrunallocationstatusenum` --- **`neq`**: `Pickrunallocationstatusenum` --- **`notilike`**: `Pickrunallocationstatusenum` --- **`notlike`**: `Pickrunallocationstatusenum` # Pickrunstatusenum Source: https://docs.firstresonance.io/api-reference/types/Pickrunstatusenum **Kind**: `enum` ## Values **`CANCELED`** **`COMPLETED`** **`EXPIRED`** **`IN_PROGRESS`** **`PENDING`** # PickrunstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PickrunstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Pickrunstatusenum` --- **`gt`**: `Pickrunstatusenum` --- **`gte`**: `Pickrunstatusenum` --- **`ilike`**: `Pickrunstatusenum` --- **`in`**: `[Pickrunstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Pickrunstatusenum` --- **`lt`**: `Pickrunstatusenum` --- **`lte`**: `Pickrunstatusenum` --- **`neq`**: `Pickrunstatusenum` --- **`notilike`**: `Pickrunstatusenum` --- **`notlike`**: `Pickrunstatusenum` # Pickrunstopstatusenum Source: https://docs.firstresonance.io/api-reference/types/Pickrunstopstatusenum **Kind**: `enum` ## Values **`PENDING`** **`PICKED`** **`SKIPPED`** # PickrunstopstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PickrunstopstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Pickrunstopstatusenum` --- **`gt`**: `Pickrunstopstatusenum` --- **`gte`**: `Pickrunstopstatusenum` --- **`ilike`**: `Pickrunstopstatusenum` --- **`in`**: `[Pickrunstopstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Pickrunstopstatusenum` --- **`lt`**: `Pickrunstopstatusenum` --- **`lte`**: `Pickrunstopstatusenum` --- **`neq`**: `Pickrunstopstatusenum` --- **`notilike`**: `Pickrunstopstatusenum` --- **`notlike`**: `Pickrunstopstatusenum` # Plan Source: https://docs.firstresonance.io/api-reference/types/Plan Plan GraphQL object. **Kind**: `object` ## Fields **`Attributes`**: `[PlanAttribute]` **Arguments:** - `filters`: `PlanAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_ConstraintsCount`**: `Int` Optimized count of constraints. --- **`_InputsCount`**: `Int` Optimized count of inputs. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[PlanAttributedPart]` **Arguments:** - `filters`: `PlanAttributedPartsInputFilters` --- **`attributedUsers`**: `[PlanAttributedUser]` **Arguments:** - `filters`: `PlanAttributedUsersInputFilters` --- **`attributes`**: `[PlanAttribute]` --- **`comments`**: `[Comment]` --- **`constraints`**: `[PlanConstraint]` **Arguments:** - `filters`: `PlanConstraintsInputFilters` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`includeInMrp`**: `Boolean!` --- **`inputs`**: `[PlanInput]` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`percentComplete`**: `Int` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`status`**: `Plansstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PlanAttribute Source: https://docs.firstresonance.io/api-reference/types/PlanAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PlanAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`planId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PlanAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PlanAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanAttribute` --- **`oldValues`**: `PlanAttribute` --- **`timestamp`**: `DateTime` # PlanAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PlanAttributedPart Auto-generated GQL type for PlanAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # PlanAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PlanAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PlanAttributedPartsInputFilters]` # PlanAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PlanAttributedUser Auto-generated GQL type for PlanAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PlanAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PlanAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PlanAttributedUsersInputFilters]` # PlanAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PlanAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PlanAttributesInputFilters]` --- **`plan`**: `PlansInputFilters` --- **`planId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PlanConstraint Source: https://docs.firstresonance.io/api-reference/types/PlanConstraint Plan Constraint GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_PlanConstraintLocationsCount`**: `Int` Optimized count of planConstraintLocations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`operator`**: `Constraintoperatorenum!` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planConstraintLocations`**: `[PlanConstraintLocation]` **Arguments:** - `filters`: `PlanConstraintLocationsInputFilters` --- **`planId`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanConstraintEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PlanConstraintEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`operator`**: `ConstraintoperatorenumFilter` --- **`planId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # PlanConstraintEvents Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanConstraint` --- **`oldValues`**: `PlanConstraint` --- **`timestamp`**: `DateTime` # PlanConstraintLocation Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintLocation Plan Constraint Location GraphQL object. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int!` --- **`planConstraint`**: `PlanConstraint` **Arguments:** - `filters`: `PlanConstraintsInputFilters` --- **`planConstraintId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanConstraintLocationEventFilter` # PlanConstraintLocationEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintLocationEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`locationId`**: `IDFilter` --- **`planConstraintId`**: `IDFilter` # PlanConstraintLocationEvents Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintLocationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanConstraintLocation` --- **`oldValues`**: `PlanConstraintLocation` --- **`timestamp`**: `DateTime` # PlanConstraintLocationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintLocationsInputFilters **Kind**: `input` ## Fields **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PlanConstraintLocationsInputFilters]` --- **`id`**: `IDFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`or_`**: `[PlanConstraintLocationsInputFilters]` --- **`planConstraint`**: `PlanConstraintsInputFilters` --- **`planConstraintId`**: `IDFilter` # PlanConstraintSortEnum Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`OPERATOR_ASC`** **`OPERATOR_DESC`** **`PLAN_ID_ASC`** **`PLAN_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PlanConstraintsConnection Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintsConnection **Kind**: `object` ## Fields **`edges`**: `[PlanConstraintsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PlanConstraintsEdge Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintsEdge A Relay edge containing a `PlanConstraints` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PlanConstraint` The item at the end of the edge # PlanConstraintsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanConstraintsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PlanConstraintsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`operator`**: `ConstraintoperatorenumFilter` --- **`or_`**: `[PlanConstraintsInputFilters]` --- **`plan`**: `PlansInputFilters` --- **`planConstraintLocations`**: `PlanConstraintLocationsInputFilters` --- **`planId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PlanEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeInMrp`**: `BooleanFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`status`**: `PlansstatusenumFilter` --- **`updatedById`**: `IDFilter` # PlanEvents Source: https://docs.firstresonance.io/api-reference/types/PlanEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Plan` --- **`oldValues`**: `Plan` --- **`timestamp`**: `DateTime` # PlanInput Source: https://docs.firstresonance.io/api-reference/types/PlanInput Input objects to plans. **Kind**: `object` ## Fields **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`completedQuantity`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`dueDate`**: `DateTime!` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `Int!` --- **`isGenerateNewDemand`**: `Boolean!` --- **`isIndependent`**: `Boolean!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`percentComplete`**: `String` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planId`**: `Int!` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`quantity`**: `Int!` --- **`serialNumber`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanInputEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PlanInputEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanInputEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Deleted`**: `BooleanFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`completedQuantity`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`dueDate`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isGenerateNewDemand`**: `BooleanFilter` --- **`isIndependent`**: `BooleanFilter` --- **`name`**: `StringFilter` --- **`partId`**: `IDFilter` --- **`percentComplete`**: `StringFilter` --- **`planId`**: `IDFilter` --- **`quantity`**: `IntFilter` --- **`serialNumber`**: `StringFilter` --- **`updatedById`**: `IDFilter` # PlanInputEvents Source: https://docs.firstresonance.io/api-reference/types/PlanInputEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanInput` --- **`oldValues`**: `PlanInput` --- **`timestamp`**: `DateTime` # PlanInputSortEnum Source: https://docs.firstresonance.io/api-reference/types/PlanInputSortEnum **Kind**: `enum` ## Values **`COMPLETED_QUANTITY_ASC`** **`COMPLETED_QUANTITY_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DUE_DATE_ASC`** **`DUE_DATE_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_GENERATE_NEW_DEMAND_ASC`** **`IS_GENERATE_NEW_DEMAND_DESC`** **`IS_INDEPENDENT_ASC`** **`IS_INDEPENDENT_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PLAN_ID_ASC`** **`PLAN_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`SERIAL_NUMBER_ASC`** **`SERIAL_NUMBER_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_DELETED_ASC`** **`_DELETED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PlanInputsConnection Source: https://docs.firstresonance.io/api-reference/types/PlanInputsConnection **Kind**: `object` ## Fields **`edges`**: `[PlanInputsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PlanInputsEdge Source: https://docs.firstresonance.io/api-reference/types/PlanInputsEdge A Relay edge containing a `PlanInputs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PlanInput` The item at the end of the edge # PlanInputsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanInputsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_deleted`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PlanInputsInputFilters]` --- **`completedQuantity`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`dueDate`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`isGenerateNewDemand`**: `BooleanFilter` --- **`isIndependent`**: `BooleanFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[PlanInputsInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`percentComplete`**: `StringFilter` --- **`plan`**: `PlansInputFilters` --- **`planId`**: `IDFilter` --- **`planItems`**: `PlanItemsInputFilters` --- **`quantity`**: `IntFilter` --- **`serialNumber`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PlanItem Source: https://docs.firstresonance.io/api-reference/types/PlanItem Plan item GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_ChildAllocationsCount`**: `Int` Optimized count of childAllocations. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_InputsCount`**: `Int` Optimized count of inputs. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_ParentAllocationsCount`**: `Int` Optimized count of parentAllocations. --- **`_PartInventoriesCount`**: `Int` Optimized count of part inventory. --- **`_PlanInputsCount`**: `Int` Optimized count of plan inputs. --- **`_PlansCount`**: `Int` Optimized count of plans. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchase_order_lines. --- **`_ResultEntitiesCount`**: `Int` Optimized count of resultEntities. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`alteredFromAutoplan`**: `Boolean!` --- **`assignedTo`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` Declare assigned_to_id column. --- **`childAllocations`**: `[PlanItemAllocation]` **Arguments:** - `filters`: `PlanItemAllocationsInputFilters` --- **`clearToBuild`**: `Boolean` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`editable`**: `Boolean` --- **`endTime`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`explode`**: `Boolean!` --- **`forecastedEndTime`**: `DateTime` --- **`forecastedStartTime`**: `DateTime` --- **`hasResults`**: `Boolean` --- **`id`**: `Int!` --- **`inputs`**: `[PlanInput]` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`isBlocked`**: `Boolean!` --- **`isFirm`**: `Boolean!` --- **`isLatest`**: `Boolean` --- **`isPlaceholder`**: `Boolean!` --- **`issueIds`**: `[Int]!` --- **`issues`**: `[Issue]` --- **`itemType`**: `Planitementitytypeenum` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mrpJob`**: `MRPJob` **Arguments:** - `filters`: `MRPJobsInputFilters` --- **`mrpJobId`**: `Int` Declare mrp_job_id column. --- **`name`**: `String!` --- **`parentAllocations`**: `[PlanItemAllocation]` **Arguments:** - `filters`: `PlanItemAllocationsInputFilters` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` Declare part_id column. --- **`partInventories`**: `[PartInventory]` --- **`partInventoryIds`**: `[Int]!` --- **`percentComplete`**: `Int` --- **`planInputIds`**: `[Int]!` --- **`planInputs`**: `PlanInput` **Arguments:** - `filters`: `PlanInputsInputFilters` --- **`plans`**: `[Plan]` **Arguments:** - `filters`: `PlansInputFilters` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` Declare procedure_id column. --- **`purchaseOrderLineIds`**: `[Int]!` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` --- **`quantity`**: `Float` --- **`ready`**: `Boolean` --- **`resultEntities`**: `[Entity]` **Arguments:** - `filters`: `EntitysInputFilters` --- **`results`**: `[PlanItemResult]` --- **`runIds`**: `[Int]!` --- **`runs`**: `[Run]` --- **`startTime`**: `DateTime` --- **`status`**: `PlanItemStatus` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` Declare supplier_id column. --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PlanItemAllocation Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocation A child/parent relationship between plan items. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`childPlanItem`**: `PlanItem` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`childPlanItemId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `ID` --- **`mrpJob`**: `MRPJob` **Arguments:** - `filters`: `MRPJobsInputFilters` --- **`mrpJobId`**: `Int` --- **`parentPlanItem`**: `PlanItem` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`parentPlanItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`quantity`**: `Float` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanItemAllocationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PlanItemAllocationEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`childPlanItemId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mrpJobId`**: `IDFilter` --- **`parentPlanItemId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedById`**: `IDFilter` # PlanItemAllocationEvents Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanItemAllocation` --- **`oldValues`**: `PlanItemAllocation` --- **`timestamp`**: `DateTime` # PlanItemAllocationSortEnum Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocationSortEnum **Kind**: `enum` ## Values **`CHILD_PLAN_ITEM_ID_ASC`** **`CHILD_PLAN_ITEM_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`MRP_JOB_ID_ASC`** **`MRP_JOB_ID_DESC`** **`PARENT_PLAN_ITEM_ID_ASC`** **`PARENT_PLAN_ITEM_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PlanItemAllocationsConnection Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocationsConnection **Kind**: `object` ## Fields **`edges`**: `[PlanItemAllocationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PlanItemAllocationsEdge Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocationsEdge A Relay edge containing a `PlanItemAllocations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PlanItemAllocation` The item at the end of the edge # PlanItemAllocationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanItemAllocationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PlanItemAllocationsInputFilters]` --- **`childPlanItem`**: `PlanItemsInputFilters` --- **`childPlanItemId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`mrpJob`**: `MRPJobsInputFilters` --- **`mrpJobId`**: `IDFilter` --- **`or_`**: `[PlanItemAllocationsInputFilters]` --- **`parentPlanItem`**: `PlanItemsInputFilters` --- **`parentPlanItemId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PlanItemEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanItemEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`alteredFromAutoplan`**: `BooleanFilter` --- **`assignedToId`**: `IDFilter` --- **`clearToBuild`**: `BooleanFilter` --- **`createdById`**: `IDFilter` --- **`editable`**: `BooleanFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`explode`**: `BooleanFilter` --- **`forecastedEndTime`**: `DateTimeFilter` --- **`forecastedStartTime`**: `DateTimeFilter` --- **`hasResults`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isBlocked`**: `BooleanFilter` --- **`isFirm`**: `BooleanFilter` --- **`isLatest`**: `BooleanFilter` --- **`isPlaceholder`**: `BooleanFilter` --- **`itemType`**: `PlanitementitytypeenumFilter` --- **`mrpJobId`**: `IDFilter` --- **`name`**: `StringFilter` --- **`partId`**: `IDFilter` --- **`percentComplete`**: `IntFilter` --- **`procedureId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`ready`**: `BooleanFilter` --- **`startTime`**: `DateTimeFilter` --- **`status`**: `PlanItemStatusFilter` --- **`supplierId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # PlanItemEvents Source: https://docs.firstresonance.io/api-reference/types/PlanItemEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanItem` --- **`oldValues`**: `PlanItem` --- **`timestamp`**: `DateTime` # PlanItemResult Source: https://docs.firstresonance.io/api-reference/types/PlanItemResult Union of GraphQL objects that can be returned as plan item results. **Kind**: `union` ## Possible types - `Issue` - `PartInventory` - `PlanInput` - `PurchaseOrderLine` - `Run` # PlanItemSortEnum Source: https://docs.firstresonance.io/api-reference/types/PlanItemSortEnum **Kind**: `enum` ## Values **`ALTERED_FROM_AUTOPLAN_ASC`** **`ALTERED_FROM_AUTOPLAN_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CLEAR_TO_BUILD_ASC`** **`CLEAR_TO_BUILD_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`EDITABLE_ASC`** **`EDITABLE_DESC`** **`END_TIME_ASC`** **`END_TIME_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`EXPLODE_ASC`** **`EXPLODE_DESC`** **`FORECASTED_END_TIME_ASC`** **`FORECASTED_END_TIME_DESC`** **`FORECASTED_START_TIME_ASC`** **`FORECASTED_START_TIME_DESC`** **`HAS_RESULTS_ASC`** **`HAS_RESULTS_DESC`** **`ID_ASC`** **`ID_DESC`** **`ISSUE_IDS_ASC`** **`ISSUE_IDS_DESC`** **`IS_BLOCKED_ASC`** **`IS_BLOCKED_DESC`** **`IS_FIRM_ASC`** **`IS_FIRM_DESC`** **`IS_LATEST_ASC`** **`IS_LATEST_DESC`** **`IS_PLACEHOLDER_ASC`** **`IS_PLACEHOLDER_DESC`** **`ITEM_TYPE_ASC`** **`ITEM_TYPE_DESC`** **`MRP_JOB_ID_ASC`** **`MRP_JOB_ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PART_INVENTORY_IDS_ASC`** **`PART_INVENTORY_IDS_DESC`** **`PERCENT_COMPLETE_ASC`** **`PERCENT_COMPLETE_DESC`** **`PLAN_INPUT_IDS_ASC`** **`PLAN_INPUT_IDS_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`PURCHASE_ORDER_LINE_IDS_ASC`** **`PURCHASE_ORDER_LINE_IDS_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`READY_ASC`** **`READY_DESC`** **`RESULT_IDS_ASC`** **`RESULT_IDS_DESC`** **`RESULT_TYPE_ASC`** **`RESULT_TYPE_DESC`** **`RUN_IDS_ASC`** **`RUN_IDS_DESC`** **`START_TIME_ASC`** **`START_TIME_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`SUPPLIER_ID_ASC`** **`SUPPLIER_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PlanItemStatus Source: https://docs.firstresonance.io/api-reference/types/PlanItemStatus Enum for plan item statuses. **Kind**: `enum` ## Values **`COMPLETE`** **`DRAFT`** **`SCHEDULED`** # PlanItemStatusFilter Source: https://docs.firstresonance.io/api-reference/types/PlanItemStatusFilter **Kind**: `input` ## Fields **`eq`**: `PlanItemStatus` --- **`gt`**: `PlanItemStatus` --- **`gte`**: `PlanItemStatus` --- **`ilike`**: `PlanItemStatus` --- **`in`**: `[PlanItemStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `PlanItemStatus` --- **`lt`**: `PlanItemStatus` --- **`lte`**: `PlanItemStatus` --- **`neq`**: `PlanItemStatus` --- **`notilike`**: `PlanItemStatus` --- **`notlike`**: `PlanItemStatus` # PlanItemToPlanInput Source: https://docs.firstresonance.io/api-reference/types/PlanItemToPlanInput Input object relating a plan item to a plan through plan item id. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`planId`**: `Int!` (required) --- **`planInputId`**: `Int` --- **`planItemId`**: `Int!` (required) # PlanItemsConnection Source: https://docs.firstresonance.io/api-reference/types/PlanItemsConnection **Kind**: `object` ## Fields **`edges`**: `[PlanItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PlanItemsEdge Source: https://docs.firstresonance.io/api-reference/types/PlanItemsEdge A Relay edge containing a `PlanItems` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PlanItem` The item at the end of the edge # PlanItemsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanItemsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`alteredFromAutoplan`**: `BooleanFilter` --- **`and_`**: `[PlanItemsInputFilters]` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`childAllocations`**: `PlanItemAllocationsInputFilters` --- **`clearToBuild`**: `BooleanFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`editable`**: `BooleanFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`explode`**: `BooleanFilter` --- **`forecastedEndTime`**: `DateTimeFilter` --- **`forecastedStartTime`**: `DateTimeFilter` --- **`hasResults`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`inputs`**: `PlanInputsInputFilters` --- **`isBlocked`**: `BooleanFilter` --- **`isFirm`**: `BooleanFilter` --- **`isLatest`**: `BooleanFilter` --- **`isPlaceholder`**: `BooleanFilter` --- **`issues`**: `IssueInputFilters` --- **`itemType`**: `PlanitementitytypeenumFilter` --- **`mrpJob`**: `MRPJobsInputFilters` --- **`mrpJobId`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[PlanItemsInputFilters]` --- **`parentAllocations`**: `PlanItemAllocationsInputFilters` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`percentComplete`**: `IntFilter` --- **`planInputs`**: `PlanInputsInputFilters` --- **`plans`**: `PlansInputFilters` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`quantity`**: `FloatFilter` --- **`ready`**: `BooleanFilter` --- **`resultEntities`**: `EntitysInputFilters` --- **`runs`**: `RunsInputFilters` --- **`startTime`**: `DateTimeFilter` --- **`status`**: `PlanItemStatusFilter` --- **`supplier`**: `SuppliersInputFilters` --- **`supplierId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PlanReservation Source: https://docs.firstresonance.io/api-reference/types/PlanReservation Input objects to plan reservations. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`plan`**: `Plan` **Arguments:** - `filters`: `PlansInputFilters` --- **`planId`**: `Int` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PlanReservationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PlanReservationEventFilter Source: https://docs.firstresonance.io/api-reference/types/PlanReservationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partInventoryId`**: `IDFilter` --- **`planId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedById`**: `IDFilter` # PlanReservationEvents Source: https://docs.firstresonance.io/api-reference/types/PlanReservationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PlanReservation` --- **`oldValues`**: `PlanReservation` --- **`timestamp`**: `DateTime` # PlanReservationSortEnum Source: https://docs.firstresonance.io/api-reference/types/PlanReservationSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PLAN_ID_ASC`** **`PLAN_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PlanReservationsConnection Source: https://docs.firstresonance.io/api-reference/types/PlanReservationsConnection **Kind**: `object` ## Fields **`edges`**: `[PlanReservationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PlanReservationsEdge Source: https://docs.firstresonance.io/api-reference/types/PlanReservationsEdge A Relay edge containing a `PlanReservations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PlanReservation` The item at the end of the edge # PlanReservationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlanReservationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PlanReservationsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[PlanReservationsInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`plan`**: `PlansInputFilters` --- **`planId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PlanSettings Source: https://docs.firstresonance.io/api-reference/types/PlanSettings Organization settings related to plans. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`driveDemandBelowPurchasedParts`**: `Boolean` --- **`driveDemandFromKits`**: `Boolean` --- **`excludeFailedRunInventoryFromAutoplan`**: `Boolean` --- **`excludeUncommittedPurchaseOrdersFromAutoplan`**: `Boolean` --- **`groupPlanItemsWithSameDate`**: `Boolean` --- **`intentAwarePlanning`**: `Boolean` --- **`preferReleasedProcedure`**: `Boolean` --- **`workingTime`**: `String` # PlanSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PlanSettingsInput Organization settings related to plans. **Kind**: `input` ## Fields **`driveDemandBelowPurchasedParts`**: `Boolean` --- **`driveDemandFromKits`**: `Boolean` --- **`excludeFailedRunInventoryFromAutoplan`**: `Boolean` --- **`excludeUncommittedPurchaseOrdersFromAutoplan`**: `Boolean` --- **`groupPlanItemsWithSameDate`**: `Boolean` --- **`intentAwarePlanning`**: `Boolean` --- **`preferReleasedProcedure`**: `Boolean` --- **`workingTime`**: `String` # PlanSortEnum Source: https://docs.firstresonance.io/api-reference/types/PlanSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`INCLUDE_IN_MRP_ASC`** **`INCLUDE_IN_MRP_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PlanStatus Source: https://docs.firstresonance.io/api-reference/types/PlanStatus Enum for plan statuses. **Kind**: `enum` ## Values **`ARCHIVED`** **`COMPLETE`** **`DRAFT`** **`IN_PROGRESS`** **`SCHEDULED`** # Planitementitytypeenum Source: https://docs.firstresonance.io/api-reference/types/Planitementitytypeenum **Kind**: `enum` ## Values **`PARTS_INVENTORY`** **`PLAN_INPUTS`** **`PLAN_ITEMS`** **`PURCHASE_ORDER_LINES`** **`RUNS`** # PlanitementitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/PlanitementitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Planitementitytypeenum` --- **`gt`**: `Planitementitytypeenum` --- **`gte`**: `Planitementitytypeenum` --- **`ilike`**: `Planitementitytypeenum` --- **`in`**: `[Planitementitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Planitementitytypeenum` --- **`lt`**: `Planitementitytypeenum` --- **`lte`**: `Planitementitytypeenum` --- **`neq`**: `Planitementitytypeenum` --- **`notilike`**: `Planitementitytypeenum` --- **`notlike`**: `Planitementitytypeenum` # PlansConnection Source: https://docs.firstresonance.io/api-reference/types/PlansConnection **Kind**: `object` ## Fields **`edges`**: `[PlansEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PlansEdge Source: https://docs.firstresonance.io/api-reference/types/PlansEdge A Relay edge containing a `Plans` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Plan` The item at the end of the edge # PlansInputFilters Source: https://docs.firstresonance.io/api-reference/types/PlansInputFilters Additional Plan filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PlansInputFilters]` --- **`attributedParts`**: `PlanAttributedPartsInputFilters` --- **`attributedUsers`**: `PlanAttributedUsersInputFilters` --- **`attributes`**: `PlanAttributesInputFilters` --- **`comments`**: `CommentsInputFilters` --- **`constraints`**: `PlanConstraintsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`includeInMrp`**: `BooleanFilter` --- **`inputs`**: `PlanInputsInputFilters` --- **`labels`**: `LabelsInputFilters` --- **`name`**: `StringFilter` --- **`or_`**: `[PlansInputFilters]` --- **`planItems`**: `PlanItemsInputFilters` --- **`status`**: `PlansstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Plansstatusenum Source: https://docs.firstresonance.io/api-reference/types/Plansstatusenum **Kind**: `enum` ## Values **`ARCHIVED`** **`COMPLETE`** **`DRAFT`** **`IN_PROGRESS`** **`SCHEDULED`** # PlansstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PlansstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Plansstatusenum` --- **`gt`**: `Plansstatusenum` --- **`gte`**: `Plansstatusenum` --- **`ilike`**: `Plansstatusenum` --- **`in`**: `[Plansstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Plansstatusenum` --- **`lt`**: `Plansstatusenum` --- **`lte`**: `Plansstatusenum` --- **`neq`**: `Plansstatusenum` --- **`notilike`**: `Plansstatusenum` --- **`notlike`**: `Plansstatusenum` # PrintLabelSettings Source: https://docs.firstresonance.io/api-reference/types/PrintLabelSettings Organization settings related to print label. **Kind**: `object` ## Fields **`allowThirdPartyPrinting`**: `Boolean` --- **`labelPrintOrder`**: `String` Order a bulk label print is sent to the printer: 'as_listed' or 'reversed'. --- **`printServerApiKey`**: `String` --- **`printServerUrl`**: `String` --- **`usePrintServer`**: `Boolean` # PrintLabelSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PrintLabelSettingsInput Organization settings related to print label. **Kind**: `input` ## Fields **`allowThirdPartyPrinting`**: `Boolean` --- **`labelPrintOrder`**: `String` Order a bulk label print is sent to the printer: 'as_listed' or 'reversed'. --- **`printServerApiKey`**: `String` --- **`printServerUrl`**: `String` --- **`usePrintServer`**: `Boolean` # PrintNodePrinter Source: https://docs.firstresonance.io/api-reference/types/PrintNodePrinter GraphQL ObjectType for representing a printer. **Kind**: `object` ## Fields **`description`**: `String` --- **`id`**: `Int!` --- **`name`**: `String!` --- **`state`**: `String!` # PrintNodePrinterConnection Source: https://docs.firstresonance.io/api-reference/types/PrintNodePrinterConnection GraphQL ObjectType for representing a list of printers as edges within a connection. **Kind**: `object` ## Fields **`edges`**: `[PrintNodePrinterEdge]` # PrintNodePrinterEdge Source: https://docs.firstresonance.io/api-reference/types/PrintNodePrinterEdge GraphQL ObjectType for representing a printer as a node within an edge. **Kind**: `object` ## Fields **`node`**: `PrintNodePrinter` # PrismaticIntegration Source: https://docs.firstresonance.io/api-reference/types/PrismaticIntegration Prismatic Integration data. **Kind**: `object` ## Fields **`serviceRoutes`**: `PrismaticServiceRoutes!` --- **`token`**: `String` # PrismaticServiceRoutes Source: https://docs.firstresonance.io/api-reference/types/PrismaticServiceRoutes Public Prismatic service routes for clients. **Kind**: `object` ## Fields **`appUrl`**: `String!` # Procedure Source: https://docs.firstresonance.io/api-reference/types/Procedure Steps to manufacture. **Kind**: `object` ## Fields **`Attributes`**: `[ProcedureAttribute]` **Arguments:** - `filters`: `ProcedureAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_FamilyLabelsCount`**: `Int` Optimized count of familyLabels. --- **`_FeedbackCount`**: `Int` Optimized count of feedback. --- **`_LocationsCount`**: `Int` Optimized count of locations. --- **`_PartProceduresCount`**: `Int` Optimized count of partProcedures. --- **`_PartsCount`**: `Int` Optimized count of parts. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_ProcedureMbomItemsCount`**: `Int` Optimized count of procedureMbomItems. --- **`_ProcedureMbomsCount`**: `Int` Optimized count of procedureMboms. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReviewRequestsCount`**: `Int` Optimized count of reviewRequests. --- **`_ReviewsCount`**: `Int` Optimized count of reviews. --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalRequests`**: `[ProcedureApprovalRequest]` **Arguments:** - `filters`: `ProcedureApprovalRequestsInputFilters` --- **`approvals`**: `[ProcedureApproval]` **Arguments:** - `filters`: `ProcedureApprovalsInputFilters` --- **`attributedParts`**: `[ProcedureAttributedPart]` **Arguments:** - `filters`: `ProcedureAttributedPartsInputFilters` --- **`attributedUsers`**: `[ProcedureAttributedUser]` **Arguments:** - `filters`: `ProcedureAttributedUsersInputFilters` --- **`attributes`**: `[ProcedureAttribute]` --- **`commitMessage`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`exportControlled`**: `Boolean` --- **`family`**: `String` --- **`familyId`**: `Int!` Get column with related family id. This value serves as a "group id" for different versions of the "same" model object. For example, all versions of a standard step will have the same family_id. If a step is not a standard step, this will just equal the value of the step's id. Returns: Column instance --- **`familyLabels`**: `[Label]` **Arguments:** - `filters`: `LabelsInputFilters` --- **`feedback`**: `[Comment]` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` Define intent option relationship. **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isLatestReleasedVersion`**: `Boolean` --- **`isLatestVersion`**: `Boolean` --- **`isRoleBased`**: `Boolean!` --- **`labels`**: `[String]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` --- **`partProcedures`**: `[PartProcedure]` **Arguments:** - `filters`: `PartProceduresInputFilters` --- **`parts`**: `[Part]` **Arguments:** - `filters`: `PartsInputFilters` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`procedureMbomItems`**: `[ProcedureMBomItem]` **Arguments:** - `filters`: `ProcedureMBomItemsInputFilters` --- **`procedureMboms`**: `[ProcedureMBom]` **Arguments:** - `filters`: `ProcedureMBomsInputFilters` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`reviewRequests`**: `[ReviewRequest]` **Arguments:** - `filters`: `ReviewRequestsInputFilters` --- **`reviews`**: `[Review]` **Arguments:** - `filters`: `ReviewsInputFilters` --- **`runs`**: `[Run]` **Arguments:** - `filters`: `RunsInputFilters` --- **`status`**: `Procedurestatusenum!` --- **`statusTransitionBlockers`**: `[ProcedureStatusTransitionBlocker]` Every gate currently blocking a transition to targetStatus (approvals, MBOM assignment, SPR match, select options, run-usage guards). Empty when the transition is allowed or is a no-op. Read-only — runs the same write-time validators without committing, so clients can preview whether a transition is allowed and why not. Runs several DB queries per procedure; intended for a single procedure preview, not batched across a procedures list. **Arguments:** - `targetStatus`: `Procedurestatusenum!` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureEventFilter` --- **`title`**: `String!` --- **`type`**: `Proceduretypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`version`**: `Int!` # ProcedureApproval Source: https://docs.firstresonance.io/api-reference/types/ProcedureApproval An approval related to an procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Procedureapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `ProcedureApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int!` --- **`replies`**: `[ProcedureApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ProcedureApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `ProcedureapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`procedureId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ProcedureApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ProcedureApproval` --- **`oldValues`**: `ProcedureApproval` --- **`timestamp`**: `DateTime` # ProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequest A request to approve an procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Procedureapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int!` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ProcedureApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `ProcedureapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`procedureId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # ProcedureApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ProcedureApprovalRequest` --- **`oldValues`**: `ProcedureApprovalRequest` --- **`timestamp`**: `DateTime` # ProcedureApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ProcedureApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequestsEdge A Relay edge containing a `ProcedureApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ProcedureApprovalRequest` The item at the end of the edge # ProcedureApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRequestsInputFilters ProcedureApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ProcedureApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `ProcedureapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ProcedureApprovalRequestsInputFilters]` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRole Approval role type for procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`gateType`**: `Procedureapprovalgatetypeenum!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureApprovalRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ProcedureApprovalRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `ProcedureapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ProcedureApprovalRoleEvents Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ProcedureApprovalRole` --- **`oldValues`**: `ProcedureApprovalRole` --- **`timestamp`**: `DateTime` # ProcedureApprovalRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ProcedureApprovalRolesConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRolesConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureApprovalRolesEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRolesEdge A Relay edge containing a `ProcedureApprovalRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ProcedureApprovalRole` The item at the end of the edge # ProcedureApprovalRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalRolesInputFilters ProcedureApprovalRole filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ProcedureApprovalRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`gateType`**: `ProcedureapprovalgatetypeenumFilter` --- **`or_`**: `[ProcedureApprovalRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ProcedureApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ProcedureApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalsEdge A Relay edge containing a `ProcedureApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ProcedureApproval` The item at the end of the edge # ProcedureApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureApprovalsInputFilters ProcedureApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ProcedureApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `ProcedureapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ProcedureApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ProcedureAttribute Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # ProcedureAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`procedureId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # ProcedureAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ProcedureAttribute` --- **`oldValues`**: `ProcedureAttribute` --- **`timestamp`**: `DateTime` # ProcedureAttributedPart Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributedPart Auto-generated GQL type for ProcedureAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # ProcedureAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[ProcedureAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[ProcedureAttributedPartsInputFilters]` # ProcedureAttributedUser Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributedUser Auto-generated GQL type for ProcedureAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # ProcedureAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[ProcedureAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[ProcedureAttributedUsersInputFilters]` # ProcedureAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[ProcedureAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[ProcedureAttributesInputFilters]` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # ProcedureEventFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`commitMessage`**: `StringFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`familyId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IntFilter` --- **`isRoleBased`**: `BooleanFilter` --- **`status`**: `ProcedurestatusenumFilter` --- **`title`**: `StringFilter` --- **`type`**: `ProceduretypeenumFilter` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # ProcedureEvents Source: https://docs.firstresonance.io/api-reference/types/ProcedureEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Procedure` --- **`oldValues`**: `Procedure` --- **`timestamp`**: `DateTime` # ProcedureFamilyLabel Source: https://docs.firstresonance.io/api-reference/types/ProcedureFamilyLabel Label related to a procedure family. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`id`**: `Int!` --- **`label`**: `Label` **Arguments:** - `filters`: `LabelsInputFilters` --- **`labelId`**: `ID!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`procedureFamilyId`**: `ID!` --- **`procedures`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ProcedureFamilyLabelEventFilter` # ProcedureFamilyLabelEventFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureFamilyLabelEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`labelId`**: `IDFilter` --- **`procedureFamilyId`**: `IDFilter` # ProcedureFamilyLabelEvents Source: https://docs.firstresonance.io/api-reference/types/ProcedureFamilyLabelEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ProcedureFamilyLabel` --- **`oldValues`**: `ProcedureFamilyLabel` --- **`timestamp`**: `DateTime` # ProcedureMBom Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBom Procedure mBOM. **Kind**: `object` ## Fields **`assignedQuantity`**: `Float!` --- **`assignedReferenceDesignatorsCount`**: `Int!` --- **`id`**: `String!` Stringified composite key of procedureId and mbomId for the graphql cache. --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int` --- **`percentAssigned`**: `Float!` assignedQuantity / quantity percentage. --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`quantity`**: `Float!` --- **`referenceDesignatorsCount`**: `Int!` # ProcedureMBomItem Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomItem Procedure mBOM items. **Kind**: `object` ## Fields **`areReferenceDesignatorsFullyAssigned`**: `Boolean!` True when all of the mBOM item's reference designators are assigned. Alsotrue if no reference designators exist on the mBOM item. --- **`assignedQuantity`**: `Float!` --- **`assignedReferenceDesignatorsCount`**: `Int!` --- **`id`**: `String!` Stringified composite key of procedureId and mbomItemId for the graphql cache. --- **`isQuantityFullyAssigned`**: `Boolean!` True when all of the mBOM item's quantity is assigned. --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`quantity`**: `Float!` --- **`referenceDesignatorsCount`**: `Int!` --- **`steps`**: `[Step]` **Arguments:** - `filters`: `StepsFilters` # ProcedureMBomItemSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomItemSortEnum **Kind**: `enum` ## Values **`ARE_REFERENCE_DESIGNATORS_FULLY_ASSIGNED_ASC`** **`ARE_REFERENCE_DESIGNATORS_FULLY_ASSIGNED_DESC`** **`ASSIGNED_QUANTITY_ASC`** **`ASSIGNED_QUANTITY_DESC`** **`ASSIGNED_REFERENCE_DESIGNATORS_COUNT_ASC`** **`ASSIGNED_REFERENCE_DESIGNATORS_COUNT_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_QUANTITY_FULLY_ASSIGNED_ASC`** **`IS_QUANTITY_FULLY_ASSIGNED_DESC`** **`MBOM_ID_ASC`** **`MBOM_ID_DESC`** **`MBOM_ITEM_ID_ASC`** **`MBOM_ITEM_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`REFERENCE_DESIGNATORS_COUNT_ASC`** **`REFERENCE_DESIGNATORS_COUNT_DESC`** # ProcedureMBomItemsConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomItemsConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureMBomItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureMBomItemsEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomItemsEdge A Relay edge containing a `ProcedureMBomItems` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ProcedureMBomItem` The item at the end of the edge # ProcedureMBomItemsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomItemsInputFilters **Kind**: `input` ## Fields **`and_`**: `[ProcedureMBomItemsInputFilters]` --- **`areReferenceDesignatorsFullyAssigned`**: `BooleanFilter` --- **`assignedQuantity`**: `FloatFilter` --- **`assignedReferenceDesignatorsCount`**: `IntFilter` --- **`id`**: `StringFilter` --- **`isQuantityFullyAssigned`**: `BooleanFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`mbomItem`**: `MBomItemsInputFilters` --- **`mbomItemId`**: `IDFilter` --- **`or_`**: `[ProcedureMBomItemsInputFilters]` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`referenceDesignatorsCount`**: `IntFilter` --- **`steps`**: `StepsFilters` # ProcedureMBomSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomSortEnum **Kind**: `enum` ## Values **`ASSIGNED_QUANTITY_ASC`** **`ASSIGNED_QUANTITY_DESC`** **`ASSIGNED_REFERENCE_DESIGNATORS_COUNT_ASC`** **`ASSIGNED_REFERENCE_DESIGNATORS_COUNT_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ID_ASC`** **`MBOM_ID_DESC`** **`PERCENT_ASSIGNED_ASC`** **`PERCENT_ASSIGNED_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`REFERENCE_DESIGNATORS_COUNT_ASC`** **`REFERENCE_DESIGNATORS_COUNT_DESC`** # ProcedureMBomsConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomsConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureMBomsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureMBomsEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomsEdge A Relay edge containing a `ProcedureMBoms` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ProcedureMBom` The item at the end of the edge # ProcedureMBomsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureMBomsInputFilters **Kind**: `input` ## Fields **`and_`**: `[ProcedureMBomsInputFilters]` --- **`assignedQuantity`**: `FloatFilter` --- **`assignedReferenceDesignatorsCount`**: `IntFilter` --- **`id`**: `StringFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`or_`**: `[ProcedureMBomsInputFilters]` --- **`percentAssigned`**: `FloatFilter` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`referenceDesignatorsCount`**: `IntFilter` # ProcedureReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/ProcedureReferenceDesignator Procedure reference designator. **Kind**: `object` ## Fields **`assignedStep`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`assignedStepId`**: `Int` --- **`id`**: `String` --- **`mbom`**: `MBom` **Arguments:** - `filters`: `MBomsInputFilters` --- **`mbomId`**: `Int` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`referenceDesignator`**: `MBomItemReferenceDesignator` **Arguments:** - `filters`: `MBomItemReferenceDesignatorsInputFilters` --- **`referenceDesignatorId`**: `Int` --- **`stepPartRequirement`**: `StepPartRequirement` **Arguments:** - `filters`: `StepPartRequirementsInputFilters` --- **`stepPartRequirementId`**: `Int` # ProcedureReferenceDesignatorSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureReferenceDesignatorSortEnum **Kind**: `enum` ## Values **`ASSIGNED_STEP_ID_ASC`** **`ASSIGNED_STEP_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ID_ASC`** **`MBOM_ID_DESC`** **`MBOM_ITEM_REFERENCE_DESIGNATOR_ID_ASC`** **`MBOM_ITEM_REFERENCE_DESIGNATOR_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`STEP_PART_REQUIREMENT_ID_ASC`** **`STEP_PART_REQUIREMENT_ID_DESC`** # ProcedureReferenceDesignatorsConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureReferenceDesignatorsConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureReferenceDesignatorsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureReferenceDesignatorsEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureReferenceDesignatorsEdge A Relay edge containing a `ProcedureReferenceDesignators` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ProcedureReferenceDesignator` The item at the end of the edge # ProcedureReferenceDesignatorsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProcedureReferenceDesignatorsInputFilters **Kind**: `input` ## Fields **`and_`**: `[ProcedureReferenceDesignatorsInputFilters]` --- **`assignedStep`**: `StepsFilters` --- **`assignedStepId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`mbom`**: `MBomsInputFilters` --- **`mbomId`**: `IDFilter` --- **`or_`**: `[ProcedureReferenceDesignatorsInputFilters]` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`referenceDesignator`**: `MBomItemReferenceDesignatorsInputFilters` --- **`referenceDesignatorId`**: `IDFilter` --- **`stepPartRequirement`**: `StepPartRequirementsInputFilters` --- **`stepPartRequirementId`**: `IDFilter` # ProcedureSettings Source: https://docs.firstresonance.io/api-reference/types/ProcedureSettings Settings related to a procedure. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`enableMbomVersionSelection`**: `Boolean` When enabled, pinned mBOM versions govern SPR/aBOM/run creation instead of falling back to the latest released mBOM. --- **`enforceMbomPartsAssignedToSteps`**: `Boolean` When enabled, all mBOM parts must be assigned to run steps, and each assembly build requirement's quantity is derived from (and kept in sync with) its per-step build-requirement demand rather than authored directly. --- **`numReviewersRequired`**: `Int` # ProcedureSettingsInput Source: https://docs.firstresonance.io/api-reference/types/ProcedureSettingsInput Input settings related to procedures. **Kind**: `input` ## Fields **`enableMbomVersionSelection`**: `Boolean` --- **`enforceMbomPartsAssignedToSteps`**: `Boolean` --- **`numReviewersRequired`**: `Int` # ProcedureSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProcedureSortEnum **Kind**: `enum` ## Values **`COMMIT_MESSAGE_ASC`** **`COMMIT_MESSAGE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FAMILY_ID_ASC`** **`FAMILY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`IS_ROLE_BASED_ASC`** **`IS_ROLE_BASED_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VERSION_ASC`** **`VERSION_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_EXPORT_CONTROLLED_ASC`** **`_EXPORT_CONTROLLED_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ProcedureStatusTransitionBlocker Source: https://docs.firstresonance.io/api-reference/types/ProcedureStatusTransitionBlocker A failing gate preventing a procedure status transition. **Kind**: `object` ## Fields **`message`**: `String!` Human-readable blocker reason, suitable for direct display. --- **`type`**: `ProcedureStatusTransitionBlockerType!` # ProcedureStatusTransitionBlockerType Source: https://docs.firstresonance.io/api-reference/types/ProcedureStatusTransitionBlockerType **Kind**: `enum` ## Values **`APPROVALS`** **`DATAGRID_OPTIONS`** **`FIELD_OPTIONS`** **`FIELD_VALIDATION_VALUES`** **`INVALID_TRANSITION`** **`LATEST_REVISION`** **`MBOM_PARTS_ASSIGNED`** **`REFERENCED_IN_RUNS`** **`SPR_MATCH`** **`USED_IN_RUNS`** # ProcedureStepsConnection Source: https://docs.firstresonance.io/api-reference/types/ProcedureStepsConnection **Kind**: `object` ## Fields **`edges`**: `[ProcedureStepsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProcedureStepsEdge Source: https://docs.firstresonance.io/api-reference/types/ProcedureStepsEdge A Relay edge containing a `ProcedureSteps` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Step` The item at the end of the edge # Procedureapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Procedureapprovalgatetypeenum **Kind**: `enum` ## Values **`RELEASED`** # ProcedureapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedureapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Procedureapprovalgatetypeenum` --- **`gt`**: `Procedureapprovalgatetypeenum` --- **`gte`**: `Procedureapprovalgatetypeenum` --- **`ilike`**: `Procedureapprovalgatetypeenum` --- **`in`**: `[Procedureapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Procedureapprovalgatetypeenum` --- **`lt`**: `Procedureapprovalgatetypeenum` --- **`lte`**: `Procedureapprovalgatetypeenum` --- **`neq`**: `Procedureapprovalgatetypeenum` --- **`notilike`**: `Procedureapprovalgatetypeenum` --- **`notlike`**: `Procedureapprovalgatetypeenum` # ProceduresConnection Source: https://docs.firstresonance.io/api-reference/types/ProceduresConnection **Kind**: `object` ## Fields **`edges`**: `[ProceduresEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProceduresEdge Source: https://docs.firstresonance.io/api-reference/types/ProceduresEdge A Relay edge containing a `Procedures` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Procedure` The item at the end of the edge # ProceduresInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProceduresInputFilters Procedures filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ProceduresInputFilters]` --- **`approvalRequests`**: `ProcedureApprovalRequestsInputFilters` --- **`approvals`**: `ProcedureApprovalsInputFilters` --- **`attributedParts`**: `ProcedureAttributedPartsInputFilters` --- **`attributedUsers`**: `ProcedureAttributedUsersInputFilters` --- **`attributes`**: `ProcedureAttributesInputFilters` --- **`commitMessage`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`exportControlled`**: `BooleanFilter` --- **`familyId`**: `IDFilter` --- **`familyLabels`**: `LabelsInputFilters` --- **`feedback`**: `CommentsInputFilters` --- **`id`**: `IDFilter` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IntFilter` --- **`isLatestReleasedVersion`**: `BooleanFilter` --- **`isLatestVersion`**: `BooleanFilter` --- **`isRoleBased`**: `BooleanFilter` --- **`label`**: `StringFilter` --- **`locationId`**: `IDFilter` --- **`locations`**: `LocationsInputFilters` --- **`or_`**: `[ProceduresInputFilters]` --- **`partProcedures`**: `PartProceduresInputFilters` --- **`parts`**: `PartsInputFilters` --- **`planItems`**: `PlanItemsInputFilters` --- **`procedureMbomItems`**: `ProcedureMBomItemsInputFilters` --- **`procedureMboms`**: `ProcedureMBomsInputFilters` --- **`procedureReferenceDesignators`**: `ProcedureReferenceDesignatorsInputFilters` --- **`reviewRequests`**: `ReviewRequestsInputFilters` --- **`reviews`**: `ReviewsInputFilters` --- **`runs`**: `RunsInputFilters` --- **`status`**: `ProcedurestatusenumFilter` --- **`steps`**: `StepsFilters` --- **`title`**: `StringFilter` --- **`type`**: `ProceduretypeenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # Procedurestatusenum Source: https://docs.firstresonance.io/api-reference/types/Procedurestatusenum **Kind**: `enum` ## Values **`ARCHIVED`** **`DRAFT`** **`IN_REVIEW`** **`RELEASED`** # ProcedurestatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/ProcedurestatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Procedurestatusenum` --- **`gt`**: `Procedurestatusenum` --- **`gte`**: `Procedurestatusenum` --- **`ilike`**: `Procedurestatusenum` --- **`in`**: `[Procedurestatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Procedurestatusenum` --- **`lt`**: `Procedurestatusenum` --- **`lte`**: `Procedurestatusenum` --- **`neq`**: `Procedurestatusenum` --- **`notilike`**: `Procedurestatusenum` --- **`notlike`**: `Procedurestatusenum` # Proceduretypeenum Source: https://docs.firstresonance.io/api-reference/types/Proceduretypeenum **Kind**: `enum` ## Values **`BUILD`** **`INSPECTION`** **`MAINTENANCE`** **`TEST`** # ProceduretypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/ProceduretypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Proceduretypeenum` --- **`gt`**: `Proceduretypeenum` --- **`gte`**: `Proceduretypeenum` --- **`ilike`**: `Proceduretypeenum` --- **`in`**: `[Proceduretypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Proceduretypeenum` --- **`lt`**: `Proceduretypeenum` --- **`lte`**: `Proceduretypeenum` --- **`neq`**: `Proceduretypeenum` --- **`notilike`**: `Proceduretypeenum` --- **`notlike`**: `Proceduretypeenum` # Project Source: https://docs.firstresonance.io/api-reference/types/Project The graphene sqlalchemy object type for project. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`archived`**: `Boolean!` --- **`code`**: `String!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Float!` Entity_id related to object. Returns: int of entity_id --- **`id`**: `ID!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ProjectSortEnum Source: https://docs.firstresonance.io/api-reference/types/ProjectSortEnum **Kind**: `enum` ## Values **`ARCHIVED_ASC`** **`ARCHIVED_DESC`** **`CODE_ASC`** **`CODE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ProjectsConnection Source: https://docs.firstresonance.io/api-reference/types/ProjectsConnection **Kind**: `object` ## Fields **`edges`**: `[ProjectsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ProjectsEdge Source: https://docs.firstresonance.io/api-reference/types/ProjectsEdge A Relay edge containing a `Projects` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Project` The item at the end of the edge # ProjectsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ProjectsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ProjectsInputFilters]` --- **`archived`**: `BooleanFilter` --- **`code`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ProjectsInputFilters]` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ProvisionCustomer Source: https://docs.firstresonance.io/api-reference/types/ProvisionCustomer Provision a new customer: DB schema, ION org, and Auth0 org. **Kind**: `object` ## Fields **`organization`**: `ProvisionCustomerResult` # ProvisionCustomerInput Source: https://docs.firstresonance.io/api-reference/types/ProvisionCustomerInput **Kind**: `input` ## Fields **`displayName`**: `String!` (required) --- **`domain`**: `String!` (required) # ProvisionCustomerResult Source: https://docs.firstresonance.io/api-reference/types/ProvisionCustomerResult Lightweight result — avoids cross-schema SQLAlchemy object issues. **Kind**: `object` ## Fields **`auth0OrgId`**: `String` --- **`domain`**: `String` --- **`id`**: `Int` # PurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrder The graphene sqlalchemy object type for purchase orders. **Kind**: `object` ## Fields **`Attributes`**: `[PurchaseOrderAttribute]` **Arguments:** - `filters`: `PurchaseOrderAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_ApprovalLevelsCount`**: `Int` Optimized count of approvalLevels. --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_FeesCount`**: `Int` Optimized count of fees. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_RequirementsCount`**: `Int` Optimized count of requirements. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`absoluteFeeCost`**: `Float!` --- **`approvalLevels`**: `[PurchaseOrderApprovalLevel]` **Arguments:** - `filters`: `PurchaseOrderApprovalLevelInputFilters` --- **`approvalRequests`**: `[PurchaseOrderApprovalRequest]` **Arguments:** - `filters`: `PurchaseOrderApprovalRequestsInputFilters` --- **`approvals`**: `[PurchaseOrderApproval]` **Arguments:** - `filters`: `PurchaseOrderApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[PurchaseOrderAttributedPart]` **Arguments:** - `filters`: `PurchaseOrderAttributedPartsInputFilters` --- **`attributedUsers`**: `[PurchaseOrderAttributedUser]` **Arguments:** - `filters`: `PurchaseOrderAttributedUsersInputFilters` --- **`attributes`**: `[PurchaseOrderAttribute]` --- **`billToLocation`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`billToLocationId`**: `Int` --- **`cost`**: `Float` Recommend use of estimatedCost and estimatedTotalCost since they account for all costs on PO lines. > Deprecated: Deprecated in favor of calculated costs. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`currency`**: `Currency` **Arguments:** - `filters`: `CurrenciesInputFilters` --- **`currencyId`**: `Int` --- **`description`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrival`**: `DateTime` Name change to be more consistent with needDate. > Deprecated: Deprecated in favor of estimatedArrivalDate. --- **`estimatedArrivalDate`**: `DateTime` The latest estimated arrival date for a PO line on this PO. --- **`estimatedCost`**: `Float` --- **`estimatedCostNotFeeExempt`**: `Float` --- **`estimatedTotalCost`**: `Float` --- **`externalReference`**: `String` --- **`fees`**: `[PurchaseOrderFee]` **Arguments:** - `filters`: `PurchaseOrderFeesInputFilters` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isOpen`**: `Boolean` --- **`isPartiallyReceived`**: `Boolean` --- **`labels`**: `[Label]` --- **`lastStatusBeforeCancel`**: `Purchaseorderstatusenum` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`needDate`**: `DateTime` The latest need date on the purchase order lines. --- **`orderedAt`**: `DateTime` --- **`paid`**: `Boolean` --- **`percentageFeeCost`**: `Float!` --- **`prettyStr`**: `String` --- **`previousTotalCost`**: `Float` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`requirements`**: `[Requirement]` --- **`shipToLocation`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`shipToLocationId`**: `Int` --- **`status`**: `Purchaseorderstatusenum` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` --- **`supplierInstructions`**: `SlateContent` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`validNextStatuses`**: `[Purchaseorderstatusenum]` # PurchaseOrderApproval Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApproval GraphQL model for an approval request related to a purchase order. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `PurchaseOrderApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`replies`**: `[PurchaseOrderApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PurchaseOrderApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`purchaseOrderId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderApproval` --- **`oldValues`**: `PurchaseOrderApproval` --- **`timestamp`**: `DateTime` # PurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevel The graphene sqlalchemy object type for purchase order approval level. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_CandidateUsersCount`**: `Int` Optimized count of candidateUsers. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`approvalLevel`**: `ApprovalLevel` **Arguments:** - `filters`: `ApprovalLevelInputFilters` --- **`approvalLevelId`**: `Int!` --- **`approvingUser`**: `User` --- **`approvingUserId`**: `Int` --- **`assignedUser`**: `User` --- **`assignedUserId`**: `Int` --- **`candidateUsers`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` --- **`costThreshold`**: `Int!` Return the minimum purchase order cost that triggers this approval level. --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`isTeamSelectedLater`**: `Boolean!` Whether the team should be selected now or when the PO goes into review. --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`ordinalPosition`**: `Int!` Return the order of this approval level in the chain. --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`role`**: `Role` --- **`roleId`**: `Int` --- **`status`**: `Approvalstatusenum!` --- **`team`**: `Team` --- **`teamId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderApprovalLevelEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PurchaseOrderApprovalLevelEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevelEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`approvalLevelId`**: `IDFilter` --- **`approvingUserId`**: `IDFilter` --- **`assignedUserId`**: `IDFilter` --- **`costThreshold`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isTeamSelectedLater`**: `BooleanFilter` --- **`ordinalPosition`**: `IntFilter` --- **`purchaseOrderId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `ApprovalstatusenumFilter` --- **`teamId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderApprovalLevelEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevelEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderApprovalLevel` --- **`oldValues`**: `PurchaseOrderApprovalLevel` --- **`timestamp`**: `DateTime` # PurchaseOrderApprovalLevelInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevelInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PurchaseOrderApprovalLevelInputFilters]` --- **`approvalLevel`**: `ApprovalLevelInputFilters` --- **`approvalLevelId`**: `IDFilter` --- **`approvingUserId`**: `IDFilter` --- **`assignedUserId`**: `IDFilter` --- **`candidateUsers`**: `UserInputFilters` --- **`costThreshold`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`isTeamSelectedLater`**: `BooleanFilter` --- **`or_`**: `[PurchaseOrderApprovalLevelInputFilters]` --- **`ordinalPosition`**: `IntFilter` --- **`purchaseOrder`**: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `ApprovalstatusenumFilter` --- **`teamId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PurchaseOrderApprovalLevelSortEnum Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevelSortEnum **Kind**: `enum` ## Values **`APPROVAL_LEVEL_ID_ASC`** **`APPROVAL_LEVEL_ID_DESC`** **`APPROVING_USER_ID_ASC`** **`APPROVING_USER_ID_DESC`** **`ASSIGNED_USER_ID_ASC`** **`ASSIGNED_USER_ID_DESC`** **`COST_THRESHOLD_ASC`** **`COST_THRESHOLD_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_TEAM_SELECTED_LATER_ASC`** **`IS_TEAM_SELECTED_LATER_DESC`** **`ORDINAL_POSITION_ASC`** **`ORDINAL_POSITION_DESC`** **`PURCHASE_ORDER_ID_ASC`** **`PURCHASE_ORDER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TEAM_ID_ASC`** **`TEAM_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PurchaseOrderApprovalLevelsConnection Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevelsConnection **Kind**: `object` ## Fields **`edges`**: `[PurchaseOrderApprovalLevelsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PurchaseOrderApprovalLevelsEdge Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalLevelsEdge A Relay edge containing a `PurchaseOrderApprovalLevels` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PurchaseOrderApprovalLevel` The item at the end of the edge # PurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequest GraphQL model for an approval request related to a purchase order. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PurchaseOrderApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`purchaseOrderId`**: `IDFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderApprovalRequest` --- **`oldValues`**: `PurchaseOrderApprovalRequest` --- **`timestamp`**: `DateTime` # PurchaseOrderApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequestSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PURCHASE_ORDER_ID_ASC`** **`PURCHASE_ORDER_ID_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PurchaseOrderApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[PurchaseOrderApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PurchaseOrderApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequestsEdge A Relay edge containing a `PurchaseOrderApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PurchaseOrderApprovalRequest` The item at the end of the edge # PurchaseOrderApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalRequestsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PurchaseOrderApprovalRequestsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[PurchaseOrderApprovalRequestsInputFilters]` --- **`purchaseOrder`**: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `IDFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PurchaseOrderApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PURCHASE_ORDER_ID_ASC`** **`PURCHASE_ORDER_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PurchaseOrderApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[PurchaseOrderApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PurchaseOrderApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalsEdge A Relay edge containing a `PurchaseOrderApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PurchaseOrderApproval` The item at the end of the edge # PurchaseOrderApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderApprovalsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PurchaseOrderApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[PurchaseOrderApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`purchaseOrder`**: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PurchaseOrderAttribute Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PurchaseOrderAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`purchaseOrderId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderAttribute` --- **`oldValues`**: `PurchaseOrderAttribute` --- **`timestamp`**: `DateTime` # PurchaseOrderAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributedPart Auto-generated GQL type for PurchaseOrderAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # PurchaseOrderAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PurchaseOrderAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PurchaseOrderAttributedPartsInputFilters]` # PurchaseOrderAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributedUser Auto-generated GQL type for PurchaseOrderAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PurchaseOrderAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PurchaseOrderAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PurchaseOrderAttributedUsersInputFilters]` # PurchaseOrderAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PurchaseOrderAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PurchaseOrderAttributesInputFilters]` --- **`purchaseOrder`**: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PurchaseOrderEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`absoluteFeeCost`**: `FloatFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`billToLocationId`**: `IDFilter` --- **`cost`**: `FloatFilter` --- **`createdById`**: `IDFilter` --- **`currencyId`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`estimatedArrivalDate`**: `DateTimeFilter` --- **`estimatedCost`**: `FloatFilter` --- **`estimatedCostNotFeeExempt`**: `FloatFilter` --- **`estimatedTotalCost`**: `FloatFilter` --- **`eventType`**: `EventTypeFilter` --- **`externalReference`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IDFilter` --- **`isPartiallyReceived`**: `BooleanFilter` --- **`lastStatusBeforeCancel`**: `PurchaseorderstatusenumFilter` --- **`needDate`**: `DateTimeFilter` --- **`orderedAt`**: `DateTimeFilter` --- **`percentageFeeCost`**: `FloatFilter` --- **`previousTotalCost`**: `FloatFilter` --- **`shipToLocationId`**: `IDFilter` --- **`status`**: `PurchaseorderstatusenumFilter` --- **`supplierId`**: `IDFilter` --- **`supplierInstructions`**: `SlateContentFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrder` --- **`oldValues`**: `PurchaseOrder` --- **`timestamp`**: `DateTime` # PurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFee The graphene sqlalchemy object type for purchase orders fees. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderFeeEventFilter` --- **`type`**: `Feetypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `Float!` # PurchaseOrderFeeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFeeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`purchaseOrderId`**: `IDFilter` --- **`type`**: `FeetypeenumFilter` --- **`updatedById`**: `IDFilter` --- **`value`**: `FloatFilter` # PurchaseOrderFeeEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFeeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderFee` --- **`oldValues`**: `PurchaseOrderFee` --- **`timestamp`**: `DateTime` # PurchaseOrderFeeSortEnum Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFeeSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`PURCHASE_ORDER_ID_ASC`** **`PURCHASE_ORDER_ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PurchaseOrderFeesConnection Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFeesConnection **Kind**: `object` ## Fields **`edges`**: `[PurchaseOrderFeesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PurchaseOrderFeesEdge Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFeesEdge A Relay edge containing a `PurchaseOrderFees` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PurchaseOrderFee` The item at the end of the edge # PurchaseOrderFeesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderFeesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PurchaseOrderFeesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[PurchaseOrderFeesInputFilters]` --- **`purchaseOrder`**: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `IDFilter` --- **`type`**: `FeetypeenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `FloatFilter` # PurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLine The graphene sqlalchemy object type for purchase order lines. **Kind**: `object` ## Fields **`Attributes`**: `[PurchaseOrderLineAttribute]` **Arguments:** - `filters`: `PurchaseOrderLineAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PurchaseOrderLineInventoriesCount`**: `Int` Optimized count of purchaseOrderLineInventories. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_ReceiptsCount`**: `Int` Optimized count of receipts. --- **`_ReceivedPartInventoriesCount`**: `Int` Optimized count of receivedPartInventories. --- **`_RequirementsCount`**: `Int` Optimized count of requirements. --- **`_RunStepsCount`**: `Int` Optimized count of runSteps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[PurchaseOrderLineAttributedPart]` **Arguments:** - `filters`: `PurchaseOrderLineAttributedPartsInputFilters` --- **`attributedUsers`**: `[PurchaseOrderLineAttributedUser]` **Arguments:** - `filters`: `PurchaseOrderLineAttributedUsersInputFilters` --- **`attributes`**: `[PurchaseOrderLineAttribute]` --- **`chargeAccount`**: `ChargeAccount` **Arguments:** - `filters`: `ChargeAccountsInputFilters` --- **`chargeAccountId`**: `ID` --- **`comments`**: `[Comment]` --- **`cost`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`estimatedArrivalDate`**: `DateTime` --- **`estimatedCost`**: `Float` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`inventoryQuantity`**: `Float` --- **`isOpen`**: `Boolean` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`needDate`**: `DateTime` --- **`originalEstimatedArrivalDate`**: `DateTime` --- **`paid`**: `Boolean!` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`percentageFeeExempt`**: `Boolean!` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`project`**: `Project` **Arguments:** - `filters`: `ProjectsInputFilters` --- **`projectId`**: `ID` --- **`purchaseOrder`**: `PurchaseOrder` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `Int!` --- **`purchaseOrderLineInventories`**: `[PurchaseOrderLineInventory]` --- **`quantity`**: `Float!` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receipts`**: `[Receipt]` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`receivedPartInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`receivedQuantity`**: `Float` --- **`requirements`**: `[Requirement]` --- **`runStep`**: `RunStep` > Deprecated: Use inventoryRunSteps instead. Returns the run step for a single-serial OSP line only. --- **`runStepId`**: `Int` > Deprecated: Use inventoryRunSteps instead. Returns the run step for a single-serial OSP line only. --- **`runSteps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`skipInventoryCreation`**: `Boolean!` --- **`status`**: `Purchaseorderstatusenum!` --- **`supplierPart`**: `SupplierPart` **Arguments:** - `filters`: `SupplierPartsInputFilters` --- **`supplierPartId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderLineEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # PurchaseOrderLineAttribute Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`purchaseOrderLine`**: `PurchaseOrderLine` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderLineAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # PurchaseOrderLineAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`purchaseOrderLineId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderLineAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderLineAttribute` --- **`oldValues`**: `PurchaseOrderLineAttribute` --- **`timestamp`**: `DateTime` # PurchaseOrderLineAttributedPart Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributedPart Auto-generated GQL type for PurchaseOrderLineAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # PurchaseOrderLineAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[PurchaseOrderLineAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PurchaseOrderLineAttributedPartsInputFilters]` # PurchaseOrderLineAttributedUser Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributedUser Auto-generated GQL type for PurchaseOrderLineAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # PurchaseOrderLineAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[PurchaseOrderLineAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[PurchaseOrderLineAttributedUsersInputFilters]` # PurchaseOrderLineAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[PurchaseOrderLineAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[PurchaseOrderLineAttributesInputFilters]` --- **`purchaseOrderLine`**: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # PurchaseOrderLineEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`chargeAccountId`**: `IDFilter` --- **`cost`**: `FloatFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`estimatedArrivalDate`**: `DateTimeFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IDFilter` --- **`needDate`**: `DateTimeFilter` --- **`originalEstimatedArrivalDate`**: `DateTimeFilter` --- **`paid`**: `BooleanFilter` --- **`partId`**: `IDFilter` --- **`percentageFeeExempt`**: `BooleanFilter` --- **`position`**: `IntFilter` --- **`projectId`**: `IDFilter` --- **`purchaseOrderId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`receivedQuantity`**: `FloatFilter` --- **`runStepId`**: `IntFilter` --- **`skipInventoryCreation`**: `BooleanFilter` --- **`status`**: `PurchaseorderstatusenumFilter` --- **`supplierPartId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # PurchaseOrderLineEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderLine` --- **`oldValues`**: `PurchaseOrderLine` --- **`timestamp`**: `DateTime` # PurchaseOrderLineInventory Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineInventory Join record linking a PO line inventory to its per-serial run step. Each entry pairs a specific serialized part inventory with its outside service processing run step (if assigned), enabling per-serial traceability when multiple units share a single PO line. **Kind**: `object` ## Fields **`Updated`**: `DateTime` --- **`mainReceiptItemId`**: `Int` --- **`partInventoryId`**: `ID!` --- **`purchaseOrderLine`**: `PurchaseOrderLine` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `ID!` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `PurchaseOrderLineInventoryEventFilter` # PurchaseOrderLineInventoryEventFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineInventoryEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`mainReceiptItemId`**: `IDFilter` --- **`partInventoryId`**: `IDFilter` --- **`purchaseOrderLineId`**: `IDFilter` --- **`runStepId`**: `IDFilter` # PurchaseOrderLineInventoryEvents Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineInventoryEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `PurchaseOrderLineInventory` --- **`oldValues`**: `PurchaseOrderLineInventory` --- **`timestamp`**: `DateTime` # PurchaseOrderLineSettings Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineSettings Organization settings related to purchase order lines. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` # PurchaseOrderLineSortEnum Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineSortEnum **Kind**: `enum` ## Values **`CHARGE_ACCOUNT_ID_ASC`** **`CHARGE_ACCOUNT_ID_DESC`** **`COST_ASC`** **`COST_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`EDITABLE_ASC`** **`EDITABLE_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ESTIMATED_ARRIVAL_DATE_ASC`** **`ESTIMATED_ARRIVAL_DATE_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`NEED_DATE_ASC`** **`NEED_DATE_DESC`** **`ORIGINAL_ESTIMATED_ARRIVAL_DATE_ASC`** **`ORIGINAL_ESTIMATED_ARRIVAL_DATE_DESC`** **`PAID_ASC`** **`PAID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PERCENTAGE_FEE_EXEMPT_ASC`** **`PERCENTAGE_FEE_EXEMPT_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`PROJECT_ID_ASC`** **`PROJECT_ID_DESC`** **`PURCHASE_ORDER_ID_ASC`** **`PURCHASE_ORDER_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`RUN_STEP_ID_ASC`** **`RUN_STEP_ID_DESC`** **`SKIP_INVENTORY_CREATION_ASC`** **`SKIP_INVENTORY_CREATION_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`SUPPLIER_PART_ID_ASC`** **`SUPPLIER_PART_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PurchaseOrderLineToInventoryInput Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLineToInventoryInput Input which connects purchase order lines to inventory. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`partInventoryId`**: `ID!` (required) --- **`purchaseOrderLineId`**: `ID!` (required) --- **`runStepId`**: `Int` # PurchaseOrderLinesConnection Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLinesConnection **Kind**: `object` ## Fields **`edges`**: `[PurchaseOrderLinesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PurchaseOrderLinesEdge Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLinesEdge A Relay edge containing a `PurchaseOrderLines` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PurchaseOrderLine` The item at the end of the edge # PurchaseOrderLinesInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderLinesInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[PurchaseOrderLinesInputFilters]` --- **`attributedParts`**: `PurchaseOrderLineAttributedPartsInputFilters` --- **`attributedUsers`**: `PurchaseOrderLineAttributedUsersInputFilters` --- **`attributes`**: `PurchaseOrderLineAttributesInputFilters` --- **`chargeAccount`**: `ChargeAccountsInputFilters` --- **`chargeAccountId`**: `IDFilter` --- **`comments`**: `CommentsInputFilters` --- **`cost`**: `FloatFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`estimatedArrivalDate`**: `DateTimeFilter` --- **`estimatedCost`**: `FloatFilter` --- **`id`**: `IDFilter` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IDFilter` --- **`inventoryQuantity`**: `FloatFilter` --- **`isOpen`**: `BooleanFilter` --- **`issues`**: `IssueInputFilters` --- **`labels`**: `LabelsInputFilters` --- **`needDate`**: `DateTimeFilter` --- **`or_`**: `[PurchaseOrderLinesInputFilters]` --- **`originalEstimatedArrivalDate`**: `DateTimeFilter` --- **`paid`**: `BooleanFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`percentageFeeExempt`**: `BooleanFilter` --- **`position`**: `IntFilter` --- **`project`**: `ProjectsInputFilters` --- **`projectId`**: `IDFilter` --- **`purchaseOrder`**: `PurchaseOrdersInputFilters` --- **`purchaseOrderId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`receiptItems`**: `ReceiptItemsInputFilters` --- **`receipts`**: `ReceiptsInputFilters` --- **`receivedPartInventories`**: `PartInventoriesInputFilters` --- **`receivedQuantity`**: `FloatFilter` --- **`requirements`**: `RequirementsInputFilters` --- **`runStepId`**: `IntFilter` --- **`runSteps`**: `RunStepsInputFilters` --- **`skipInventoryCreation`**: `BooleanFilter` --- **`status`**: `PurchaseorderstatusenumFilter` --- **`supplierPart`**: `SupplierPartsInputFilters` --- **`supplierPartId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # PurchaseOrderSettings Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderSettings Organization settings related to purchase orders. **Kind**: `object` ## Fields **`approvalResetAbsCostChangeThreshold`**: `Int` --- **`approvalResetPctCostChangeThreshold`**: `Float` --- **`approvalResetThresholdOperator`**: `String` --- **`attributes`**: `[AttributeSettings]` --- **`autoAssignToCreator`**: `Boolean` --- **`billToLocationId`**: `Int` --- **`defaultCurrencyId`**: `Int` --- **`defaultTermsId`**: `Int` --- **`numApproversRequired`**: `Int` --- **`shipToLocationId`**: `Int` # PurchaseOrderSettingsInput Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderSettingsInput Input settings related to purchase orders. **Kind**: `input` ## Fields **`approvalResetAbsCostChangeThreshold`**: `Int` --- **`approvalResetPctCostChangeThreshold`**: `Float` --- **`approvalResetThresholdOperator`**: `String` = "and" --- **`autoAssignToCreator`**: `Boolean` --- **`billToLocationId`**: `Int` --- **`defaultCurrencyId`**: `Int` --- **`defaultTermsId`**: `Int` --- **`numApproversRequired`**: `Int` --- **`shipToLocationId`**: `Int` # PurchaseOrderSortEnum Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrderSortEnum **Kind**: `enum` ## Values **`ABSOLUTE_FEE_COST_ASC`** **`ABSOLUTE_FEE_COST_DESC`** **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`BILL_TO_LOCATION_ID_ASC`** **`BILL_TO_LOCATION_ID_DESC`** **`COST_ASC`** **`COST_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`CURRENCY_ID_ASC`** **`CURRENCY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ESTIMATED_ARRIVAL_DATE_ASC`** **`ESTIMATED_ARRIVAL_DATE_DESC`** **`ESTIMATED_COST_ASC`** **`ESTIMATED_COST_DESC`** **`ESTIMATED_COST_NOT_FEE_EXEMPT_ASC`** **`ESTIMATED_COST_NOT_FEE_EXEMPT_DESC`** **`ESTIMATED_TOTAL_COST_ASC`** **`ESTIMATED_TOTAL_COST_DESC`** **`EXTERNAL_REFERENCE_ASC`** **`EXTERNAL_REFERENCE_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`IS_PARTIALLY_RECEIVED_ASC`** **`IS_PARTIALLY_RECEIVED_DESC`** **`LAST_STATUS_BEFORE_CANCEL_ASC`** **`LAST_STATUS_BEFORE_CANCEL_DESC`** **`NEED_DATE_ASC`** **`NEED_DATE_DESC`** **`ORDERED_AT_ASC`** **`ORDERED_AT_DESC`** **`PERCENTAGE_FEE_COST_ASC`** **`PERCENTAGE_FEE_COST_DESC`** **`PREVIOUS_TOTAL_COST_ASC`** **`PREVIOUS_TOTAL_COST_DESC`** **`SHIP_TO_LOCATION_ID_ASC`** **`SHIP_TO_LOCATION_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`SUPPLIER_ID_ASC`** **`SUPPLIER_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # PurchaseOrdersConnection Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrdersConnection **Kind**: `object` ## Fields **`edges`**: `[PurchaseOrdersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # PurchaseOrdersEdge Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrdersEdge A Relay edge containing a `PurchaseOrders` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PurchaseOrder` The item at the end of the edge # PurchaseOrdersInputFilters Source: https://docs.firstresonance.io/api-reference/types/PurchaseOrdersInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`absoluteFeeCost`**: `FloatFilter` --- **`and_`**: `[PurchaseOrdersInputFilters]` --- **`approvalLevels`**: `PurchaseOrderApprovalLevelInputFilters` --- **`approvalRequests`**: `PurchaseOrderApprovalRequestsInputFilters` --- **`approvals`**: `PurchaseOrderApprovalsInputFilters` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`attributedParts`**: `PurchaseOrderAttributedPartsInputFilters` --- **`attributedUsers`**: `PurchaseOrderAttributedUsersInputFilters` --- **`attributes`**: `PurchaseOrderAttributesInputFilters` --- **`billToLocation`**: `LocationsInputFilters` --- **`billToLocationId`**: `IDFilter` --- **`cost`**: `FloatFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`currency`**: `CurrenciesInputFilters` --- **`currencyId`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`estimatedArrival`**: `DateTimeFilter` --- **`estimatedArrivalDate`**: `DateTimeFilter` --- **`estimatedCost`**: `FloatFilter` --- **`estimatedCostNotFeeExempt`**: `FloatFilter` --- **`estimatedTotalCost`**: `FloatFilter` --- **`externalReference`**: `StringFilter` --- **`fees`**: `PurchaseOrderFeesInputFilters` --- **`id`**: `IDFilter` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IDFilter` --- **`isOpen`**: `BooleanFilter` --- **`isPartiallyReceived`**: `BooleanFilter` --- **`labels`**: `LabelsInputFilters` --- **`lastStatusBeforeCancel`**: `PurchaseorderstatusenumFilter` --- **`needDate`**: `DateTimeFilter` --- **`or_`**: `[PurchaseOrdersInputFilters]` --- **`orderedAt`**: `DateTimeFilter` --- **`paid`**: `BooleanFilter` --- **`percentageFeeCost`**: `FloatFilter` --- **`previousTotalCost`**: `FloatFilter` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`requirements`**: `RequirementsInputFilters` --- **`shipToLocation`**: `LocationsInputFilters` --- **`shipToLocationId`**: `IDFilter` --- **`status`**: `PurchaseorderstatusenumFilter` --- **`supplier`**: `SuppliersInputFilters` --- **`supplierId`**: `IDFilter` --- **`supplierInstructions`**: `SlateContentNullFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Purchaseorderstatusenum Source: https://docs.firstresonance.io/api-reference/types/Purchaseorderstatusenum **Kind**: `enum` ## Values **`APPROVED`** **`CANCELED`** **`DRAFT`** **`ORDERED`** **`RECEIVED`** **`REQUESTED`** # PurchaseorderstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/PurchaseorderstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Purchaseorderstatusenum` --- **`gt`**: `Purchaseorderstatusenum` --- **`gte`**: `Purchaseorderstatusenum` --- **`ilike`**: `Purchaseorderstatusenum` --- **`in`**: `[Purchaseorderstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Purchaseorderstatusenum` --- **`lt`**: `Purchaseorderstatusenum` --- **`lte`**: `Purchaseorderstatusenum` --- **`neq`**: `Purchaseorderstatusenum` --- **`notilike`**: `Purchaseorderstatusenum` --- **`notlike`**: `Purchaseorderstatusenum` # PylonIntegration Source: https://docs.firstresonance.io/api-reference/types/PylonIntegration Pylon Integration data. The email_hash field is used for identity verification in the Pylon chat widget. See: https://docs.usepylon.com/pylon-docs/chat-widget/identity-verification **Kind**: `object` ## Fields **`emailHash`**: `String` # Receipt Source: https://docs.firstresonance.io/api-reference/types/Receipt Receipt GraphQL object. **Kind**: `object` ## Fields **`Attributes`**: `[ReceiptAttribute]` **Arguments:** - `filters`: `ReceiptAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchase order lines. --- **`_ReceiptItemsCount`**: `Int` Optimized count of receiptItems. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedParts`**: `[ReceiptAttributedPart]` **Arguments:** - `filters`: `ReceiptAttributedPartsInputFilters` --- **`attributedUsers`**: `[ReceiptAttributedUser]` **Arguments:** - `filters`: `ReceiptAttributedUsersInputFilters` --- **`attributes`**: `[ReceiptAttribute]` --- **`comments`**: `[Comment]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`prettyStr`**: `String` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`receiptItems`**: `[ReceiptItem]` **Arguments:** - `filters`: `ReceiptItemsInputFilters` --- **`receivedAt`**: `DateTime!` --- **`receivedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`receivedById`**: `Int!` --- **`receivedParts`**: `[ReceiptItem]` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReceiptEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ReceiptAttribute Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`receipt`**: `Receipt` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`receiptId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReceiptAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # ReceiptAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`receiptId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # ReceiptAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ReceiptAttribute` --- **`oldValues`**: `ReceiptAttribute` --- **`timestamp`**: `DateTime` # ReceiptAttributedPart Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributedPart Auto-generated GQL type for ReceiptAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # ReceiptAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[ReceiptAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[ReceiptAttributedPartsInputFilters]` # ReceiptAttributedUser Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributedUser Auto-generated GQL type for ReceiptAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # ReceiptAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[ReceiptAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[ReceiptAttributedUsersInputFilters]` # ReceiptAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReceiptAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[ReceiptAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[ReceiptAttributesInputFilters]` --- **`receipt`**: `ReceiptsInputFilters` --- **`receiptId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # ReceiptEventFilter Source: https://docs.firstresonance.io/api-reference/types/ReceiptEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`receivedAt`**: `DateTimeFilter` --- **`receivedById`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ReceiptEvents Source: https://docs.firstresonance.io/api-reference/types/ReceiptEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Receipt` --- **`oldValues`**: `Receipt` --- **`timestamp`**: `DateTime` # ReceiptItem Source: https://docs.firstresonance.io/api-reference/types/ReceiptItem Receipt Item GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`prettyStr`**: `String` --- **`purchaseOrderLine`**: `PurchaseOrderLine` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `Int` --- **`quantity`**: `Float!` --- **`receipt`**: `Receipt` **Arguments:** - `filters`: `ReceiptsInputFilters` --- **`receiptId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReceiptItemEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ReceiptItemEventFilter Source: https://docs.firstresonance.io/api-reference/types/ReceiptItemEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partInventoryId`**: `IDFilter` --- **`purchaseOrderLineId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`receiptId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ReceiptItemEvents Source: https://docs.firstresonance.io/api-reference/types/ReceiptItemEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ReceiptItem` --- **`oldValues`**: `ReceiptItem` --- **`timestamp`**: `DateTime` # ReceiptItemSortEnum Source: https://docs.firstresonance.io/api-reference/types/ReceiptItemSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PURCHASE_ORDER_LINE_ID_ASC`** **`PURCHASE_ORDER_LINE_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`RECEIPT_ID_ASC`** **`RECEIPT_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ReceiptItemsConnection Source: https://docs.firstresonance.io/api-reference/types/ReceiptItemsConnection **Kind**: `object` ## Fields **`edges`**: `[ReceiptItemsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ReceiptItemsEdge Source: https://docs.firstresonance.io/api-reference/types/ReceiptItemsEdge A Relay edge containing a `ReceiptItems` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ReceiptItem` The item at the end of the edge # ReceiptItemsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReceiptItemsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ReceiptItemsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ReceiptItemsInputFilters]` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`purchaseOrderLine`**: `PurchaseOrderLinesInputFilters` --- **`purchaseOrderLineId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`receipt`**: `ReceiptsInputFilters` --- **`receiptId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ReceiptSettings Source: https://docs.firstresonance.io/api-reference/types/ReceiptSettings Organization settings related to receipts. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` # ReceiptSortEnum Source: https://docs.firstresonance.io/api-reference/types/ReceiptSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`RECEIVED_AT_ASC`** **`RECEIVED_AT_DESC`** **`RECEIVED_BY_ID_ASC`** **`RECEIVED_BY_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ReceiptsConnection Source: https://docs.firstresonance.io/api-reference/types/ReceiptsConnection **Kind**: `object` ## Fields **`edges`**: `[ReceiptsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ReceiptsEdge Source: https://docs.firstresonance.io/api-reference/types/ReceiptsEdge A Relay edge containing a `Receipts` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Receipt` The item at the end of the edge # ReceiptsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReceiptsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ReceiptsInputFilters]` --- **`attributedParts`**: `ReceiptAttributedPartsInputFilters` --- **`attributedUsers`**: `ReceiptAttributedUsersInputFilters` --- **`attributes`**: `ReceiptAttributesInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ReceiptsInputFilters]` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`receiptItems`**: `ReceiptItemsInputFilters` --- **`receivedAt`**: `DateTimeFilter` --- **`receivedBy`**: `UserInputFilters` --- **`receivedById`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Recommendation Source: https://docs.firstresonance.io/api-reference/types/Recommendation Recommendation object type. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_updated`**: `DateTime` --- **`id`**: `ID!` --- **`objectStoreUri`**: `String` --- **`orgSchema`**: `String!` --- **`requestId`**: `String!` --- **`status`**: `Recommendationstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RecommendationEventFilter` # RecommendationEventFilter Source: https://docs.firstresonance.io/api-reference/types/RecommendationEventFilter **Kind**: `input` ## Fields **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` # RecommendationEvents Source: https://docs.firstresonance.io/api-reference/types/RecommendationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Recommendation` --- **`oldValues`**: `Recommendation` --- **`timestamp`**: `DateTime` # Recommendationstatusenum Source: https://docs.firstresonance.io/api-reference/types/Recommendationstatusenum **Kind**: `enum` ## Values **`COMPLETED`** **`FAILED`** **`IN_PROGRESS`** # RecomputeMbomChangeOrderLineDiffs Source: https://docs.firstresonance.io/api-reference/types/RecomputeMbomChangeOrderLineDiffs Restate the named lines' diffs against the world now. The button behind the drift banner, scoped to whichever lines the caller names. Nothing else restates: apply refuses on drift, and returning to draft or reopening leaves every diff row as it is, so the author decides when the set moves. Draft only. Under review or approved, return the change order to draft first; canceled or completed, reopen it first. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # RecomputeMbomChangeOrderLineDiffsInput Source: https://docs.firstresonance.io/api-reference/types/RecomputeMbomChangeOrderLineDiffsInput The lines to restate, with the change order's etag. Line-scoped: naming one drifted line restates only it. A whole-order recompute names every open line. **Kind**: `input` ## Fields **`changeOrderId`**: `Int!` (required) --- **`etag`**: `String!` (required) --- **`mbomChangeOrderLineIds`**: `[Int]!` (required) # Redline Source: https://docs.firstresonance.io/api-reference/types/Redline Changes made to a particular Run, RunSteps or RunStepFields. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_RoleBasedApprovalRequestsCount`**: `Int` Optimized count of roleBasedApprovalRequests. --- **`_RoleBasedApprovalsCount`**: `Int` Optimized count of roleBasedApprovals. --- **`_TargetRedlinesCount`**: `Int` Optimized count of targetRedlines. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`active`**: `Boolean` --- **`approvalRequests`**: `[RedlineApprovalRequest]` **Arguments:** - `filters`: `RedlineApprovalRequestsInputFilters` --- **`approvals`**: `[RedlineApproval]` **Arguments:** - `filters`: `RedlineApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`batchSiblings`**: `[Redline]` --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`diff`**: `JSONString` --- **`editable`**: `String` --- **`finalState`**: `JSONString` --- **`id`**: `Int!` --- **`initialState`**: `JSONString` --- **`isRoleBased`**: `Boolean` --- **`issue`**: `Issue` --- **`issueId`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`roleBasedApprovalRequests`**: `[RedlineRoleBasedApprovalRequest]` **Arguments:** - `filters`: `RedlineRoleBasedApprovalRequestsInputFilters` --- **`roleBasedApprovals`**: `[RedlineRoleBasedApproval]` **Arguments:** - `filters`: `RedlineRoleBasedApprovalsInputFilters` --- **`runId`**: `String` --- **`sourceRedline`**: `Redline` --- **`sourceRedlineId`**: `Int` --- **`status`**: `String` --- **`step`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`stepId`**: `Int!` --- **`targetRedlines`**: `[Redline]` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RedlineApproval Source: https://docs.firstresonance.io/api-reference/types/RedlineApproval GraphQL model for an approval request related to a redline. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batchSiblings`**: `[RedlineApproval]` --- **`batched`**: `Boolean` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `RedlineApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`replies`**: `[RedlineApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RedlineApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`redlineId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # RedlineApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RedlineApproval` --- **`oldValues`**: `RedlineApproval` --- **`timestamp`**: `DateTime` # RedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequest GraphQL model for an approval request related to a redline. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batchSiblings`**: `[RedlineApprovalRequest]` --- **`batched`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RedlineApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`redlineId`**: `IDFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # RedlineApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RedlineApprovalRequest` --- **`oldValues`**: `RedlineApprovalRequest` --- **`timestamp`**: `DateTime` # RedlineApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequestSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`REDLINE_ID_ASC`** **`REDLINE_ID_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RedlineApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[RedlineApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RedlineApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequestsEdge A Relay edge containing a `RedlineApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RedlineApprovalRequest` The item at the end of the edge # RedlineApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRequestsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RedlineApprovalRequestsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RedlineApprovalRequestsInputFilters]` --- **`redline`**: `RedlinesInputFilters` --- **`redlineId`**: `IDFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRole Approval role type for redlines. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`gateType`**: `Redlineapprovalgatetypeenum!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineApprovalRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RedlineApprovalRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `RedlineapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # RedlineApprovalRoleEvents Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RedlineApprovalRole` --- **`oldValues`**: `RedlineApprovalRole` --- **`timestamp`**: `DateTime` # RedlineApprovalRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RedlineApprovalRolesConnection Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRolesConnection **Kind**: `object` ## Fields **`edges`**: `[RedlineApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RedlineApprovalRolesEdge Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRolesEdge A Relay edge containing a `RedlineApprovalRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RedlineApprovalRole` The item at the end of the edge # RedlineApprovalRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalRolesInputFilters RedlineApprovalRole filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RedlineApprovalRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`gateType`**: `RedlineapprovalgatetypeenumFilter` --- **`or_`**: `[RedlineApprovalRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RedlineApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`REDLINE_ID_ASC`** **`REDLINE_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RedlineApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[RedlineApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RedlineApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalsEdge A Relay edge containing a `RedlineApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RedlineApproval` The item at the end of the edge # RedlineApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RedlineApprovalsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RedlineApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RedlineApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`redline`**: `RedlinesInputFilters` --- **`redlineId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RedlineEventFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`active`**: `BooleanFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`finalState`**: `JSONStringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`initialState`**: `JSONStringFilter` --- **`isRoleBased`**: `BooleanFilter` --- **`issueId`**: `IDFilter` --- **`sourceRedlineId`**: `IDFilter` --- **`status`**: `StringFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # RedlineEvents Source: https://docs.firstresonance.io/api-reference/types/RedlineEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Redline` --- **`oldValues`**: `Redline` --- **`timestamp`**: `DateTime` # RedlineRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApproval An approval related to a redline using role-based approvals. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batched`**: `String` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Redlineapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `RedlineRoleBasedApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`replies`**: `[RedlineRoleBasedApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineRoleBasedApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RedlineRoleBasedApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `RedlineapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`redlineId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # RedlineRoleBasedApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RedlineRoleBasedApproval` --- **`oldValues`**: `RedlineRoleBasedApproval` --- **`timestamp`**: `DateTime` # RedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequest A request to approve a redline using role-based approvals. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`batched`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Redlineapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`redline`**: `Redline` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`redlineId`**: `Int!` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RedlineRoleBasedApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RedlineRoleBasedApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `RedlineapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`redlineId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # RedlineRoleBasedApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RedlineRoleBasedApprovalRequest` --- **`oldValues`**: `RedlineRoleBasedApprovalRequest` --- **`timestamp`**: `DateTime` # RedlineRoleBasedApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`REDLINE_ID_ASC`** **`REDLINE_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RedlineRoleBasedApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[RedlineRoleBasedApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RedlineRoleBasedApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequestsEdge A Relay edge containing a `RedlineRoleBasedApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RedlineRoleBasedApprovalRequest` The item at the end of the edge # RedlineRoleBasedApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalRequestsInputFilters RedlineRoleBasedApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RedlineRoleBasedApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `RedlineapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RedlineRoleBasedApprovalRequestsInputFilters]` --- **`redline`**: `RedlinesInputFilters` --- **`redlineId`**: `IDFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RedlineRoleBasedApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`REDLINE_ID_ASC`** **`REDLINE_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RedlineRoleBasedApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[RedlineRoleBasedApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RedlineRoleBasedApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalsEdge A Relay edge containing a `RedlineRoleBasedApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RedlineRoleBasedApproval` The item at the end of the edge # RedlineRoleBasedApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RedlineRoleBasedApprovalsInputFilters RedlineRoleBasedApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RedlineRoleBasedApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `RedlineapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RedlineRoleBasedApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`redline`**: `RedlinesInputFilters` --- **`redlineId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RedlineSettings Source: https://docs.firstresonance.io/api-reference/types/RedlineSettings Settings related to redline. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`autoSubmitOnApproval`**: `Boolean` --- **`numApproversRequired`**: `Int` # RedlineSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RedlineSettingsInput Input settings related to redline. **Kind**: `input` ## Fields **`autoSubmitOnApproval`**: `Boolean` --- **`numApproversRequired`**: `Int` # RedlineSortEnum Source: https://docs.firstresonance.io/api-reference/types/RedlineSortEnum **Kind**: `enum` ## Values **`ACTIVE_ASC`** **`ACTIVE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`ISSUE_ID_ASC`** **`ISSUE_ID_DESC`** **`IS_ROLE_BASED_ASC`** **`IS_ROLE_BASED_DESC`** **`SOURCE_REDLINE_ID_ASC`** **`SOURCE_REDLINE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # Redlineapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Redlineapprovalgatetypeenum **Kind**: `enum` ## Values **`CLOSED`** # RedlineapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/RedlineapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Redlineapprovalgatetypeenum` --- **`gt`**: `Redlineapprovalgatetypeenum` --- **`gte`**: `Redlineapprovalgatetypeenum` --- **`ilike`**: `Redlineapprovalgatetypeenum` --- **`in`**: `[Redlineapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Redlineapprovalgatetypeenum` --- **`lt`**: `Redlineapprovalgatetypeenum` --- **`lte`**: `Redlineapprovalgatetypeenum` --- **`neq`**: `Redlineapprovalgatetypeenum` --- **`notilike`**: `Redlineapprovalgatetypeenum` --- **`notlike`**: `Redlineapprovalgatetypeenum` # RedlinesConnection Source: https://docs.firstresonance.io/api-reference/types/RedlinesConnection **Kind**: `object` ## Fields **`edges`**: `[RedlinesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RedlinesEdge Source: https://docs.firstresonance.io/api-reference/types/RedlinesEdge A Relay edge containing a `Redlines` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Redline` The item at the end of the edge # RedlinesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RedlinesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`active`**: `BooleanFilter` --- **`and_`**: `[RedlinesInputFilters]` --- **`approvalRequests`**: `RedlineApprovalRequestsInputFilters` --- **`approvals`**: `RedlineApprovalsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`finalState`**: `JSONStringNullFilter` --- **`id`**: `IDFilter` --- **`initialState`**: `JSONStringNullFilter` --- **`isRoleBased`**: `BooleanFilter` --- **`issueId`**: `IDFilter` --- **`or_`**: `[RedlinesInputFilters]` --- **`roleBasedApprovalRequests`**: `RedlineRoleBasedApprovalRequestsInputFilters` --- **`roleBasedApprovals`**: `RedlineRoleBasedApprovalsInputFilters` --- **`runId`**: `StringFilter` --- **`sourceRedlineId`**: `IDFilter` --- **`status`**: `StringFilter` --- **`step`**: `RunStepsInputFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RegisterOAuthApp Source: https://docs.firstresonance.io/api-reference/types/RegisterOAuthApp Register a new OAuth application for the organization. **Kind**: `object` ## Fields **`oauthApp`**: `OAuthAppRegistrationObject` # RemoveAllInventoryFromKit Source: https://docs.firstresonance.io/api-reference/types/RemoveAllInventoryFromKit Remove all inventories from part kit. **Kind**: `object` ## Fields **`partKit`**: `PartKit` # RemoveAllInventoryFromKitInput Source: https://docs.firstresonance.io/api-reference/types/RemoveAllInventoryFromKitInput Inputs needed to remove al inventories from part kit. **Kind**: `input` ## Fields **`etag`**: `String!` (required) Etag of the part kit. --- **`id`**: `Int!` (required) # RemoveAssetFromItem Source: https://docs.firstresonance.io/api-reference/types/RemoveAssetFromItem Mutation to remove an asset from an item without deleting the file attachment. **Kind**: `object` ## Fields **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachmentId`**: `Int` # RemoveHeaderFromWebhookReceiver Source: https://docs.firstresonance.io/api-reference/types/RemoveHeaderFromWebhookReceiver Mutation to remove a header from a webhook receiver. **Kind**: `object` ## Fields **`webhookReceiver`**: `WebhookReceiver` # RemoveInputFromPlan Source: https://docs.firstresonance.io/api-reference/types/RemoveInputFromPlan **Kind**: `object` ## Fields **`id`**: `Int` # RemoveInventoryFromPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/RemoveInventoryFromPurchaseOrderLine Mutation to remove an inventory item from a purchase order line. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` # RemoveInventoryFromReceipt Source: https://docs.firstresonance.io/api-reference/types/RemoveInventoryFromReceipt Remove inventory from receipt. **Kind**: `object` ## Fields **`receipt`**: `Receipt` # RemoveInventoryFromReceiptInput Source: https://docs.firstresonance.io/api-reference/types/RemoveInventoryFromReceiptInput Input object to remove inventory from receipt. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`partInventoryId`**: `Int!` (required) --- **`receiptId`**: `Int!` (required) # RemoveItemFromReceipt Source: https://docs.firstresonance.io/api-reference/types/RemoveItemFromReceipt Remove item from receipt. **Kind**: `object` ## Fields **`receipt`**: `Receipt` # RemoveItemFromReceiptInput Source: https://docs.firstresonance.io/api-reference/types/RemoveItemFromReceiptInput Input object to remove inventory from receipt. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`receiptId`**: `Int!` (required) # RemoveLabelFromItem Source: https://docs.firstresonance.io/api-reference/types/RemoveLabelFromItem Mutation to remove a label from an item which has an entity. **Kind**: `object` ## Fields **`entityId`**: `Int` --- **`labelId`**: `Int` # RemoveLabelFromProcedureFamily Source: https://docs.firstresonance.io/api-reference/types/RemoveLabelFromProcedureFamily Removes a label from a procedure family given family and label ids. **Kind**: `object` ## Fields **`familyId`**: `Int` --- **`labelId`**: `Int` # RemoveOAuthRedirectUri Source: https://docs.firstresonance.io/api-reference/types/RemoveOAuthRedirectUri Remove a callback URL or allowed origin from an OAuth app. **Kind**: `object` ## Fields **`success`**: `Boolean` # RemovePartInventoryFromRunStep Source: https://docs.firstresonance.io/api-reference/types/RemovePartInventoryFromRunStep Remove a part inventory from a run step. **Kind**: `object` ## Fields **`runStep`**: `RunStep` # RemovePartInventoryFromRunStepInput Source: https://docs.firstresonance.io/api-reference/types/RemovePartInventoryFromRunStepInput Inputs needed remove a part inventory from a run step. **Kind**: `input` ## Fields **`etag`**: `String!` (required) Etag of the run step. --- **`partInventoryId`**: `ID!` (required) --- **`runStepId`**: `ID!` (required) # RemovePlanItemFromPlan Source: https://docs.firstresonance.io/api-reference/types/RemovePlanItemFromPlan Remove plan item from plan. **Kind**: `object` ## Fields **`plan`**: `Plan` # RemoveRequirementFromItem Source: https://docs.firstresonance.io/api-reference/types/RemoveRequirementFromItem Mutation to remove a requirement from an item which has an entity. **Kind**: `object` ## Fields **`entityId`**: `Int` --- **`requirementId`**: `Int` # RemoveResultFromPlanItem Source: https://docs.firstresonance.io/api-reference/types/RemoveResultFromPlanItem Remove result from plan item. **Kind**: `object` ## Fields **`planItem`**: `PlanItem` # RemoveSubtypeFromPart Source: https://docs.firstresonance.io/api-reference/types/RemoveSubtypeFromPart Remove part subtype from part. **Kind**: `object` ## Fields **`part`**: `Part` # RemoveUserFromTeam Source: https://docs.firstresonance.io/api-reference/types/RemoveUserFromTeam Removes a User from a Team given an Id. **Kind**: `object` ## Fields **`teamId`**: `Int` --- **`userId`**: `Int` # ReopenChangeOrder Source: https://docs.firstresonance.io/api-reference/types/ReopenChangeOrder Reopen a canceled or completed change order as a draft. Separate from Return to draft: both land on draft, but reversing a closure is its own decision and carries its own permission. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # ReorderApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/ReorderApprovalLevel Reorders an ApprovalLevel given a ReorderApprovalLevelInput. **Kind**: `object` ## Fields **`approvalLevels`**: `[ApprovalLevel]` # ReorderApprovalLevelInput Source: https://docs.firstresonance.io/api-reference/types/ReorderApprovalLevelInput Inputs needed to ReorderApprovalLevel. **Kind**: `input` ## Fields **`id`**: `ID` --- **`ordinalPosition`**: `Int` # ReorderDatagridColumn Source: https://docs.firstresonance.io/api-reference/types/ReorderDatagridColumn Reorder a datagrid column to a new index. **Kind**: `object` ## Fields **`datagridColumn`**: `DatagridColumn` # ReorderDatagridInput Source: https://docs.firstresonance.io/api-reference/types/ReorderDatagridInput Input needed to reorder a datagrid row or column. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`index`**: `Int!` (required) # ReorderDatagridRow Source: https://docs.firstresonance.io/api-reference/types/ReorderDatagridRow Reorder a datagrid row to a new index. **Kind**: `object` ## Fields **`datagridRow`**: `DatagridRow` # ReorderIntentOptions Source: https://docs.firstresonance.io/api-reference/types/ReorderIntentOptions Reorders intent options given a ReorderIntentOptionsInput argument. **Kind**: `object` ## Fields **`intentOptions`**: `[IntentOption]` # ReorderIntentOptionsInput Source: https://docs.firstresonance.io/api-reference/types/ReorderIntentOptionsInput Inputs needed to reorder intent options. **Kind**: `input` ## Fields **`intentOptions`**: `[UpdateIntentOptionInput]!` (required) # ReorderLocationPickOrder Source: https://docs.firstresonance.io/api-reference/types/ReorderLocationPickOrder Order one level of the pick walk and renumber the tree to match. The client sends the order for a single level; the sequence numbers are derived here, next to the rule the pick list sorts by, so the two cannot drift. The whole tree is renumbered in one transaction, and only the locations whose sequence actually moves are written. **Kind**: `object` ## Fields **`locations`**: `[Location]` # ReorderLocationPickOrderInput Source: https://docs.firstresonance.io/api-reference/types/ReorderLocationPickOrderInput Inputs needed to order one level of the pick walk. **Kind**: `input` ## Fields **`orderedLocationIds`**: `[ID]!` (required) Every pickable, unarchived child of the parent, in the order a picker walks them. The set must match the parent's current children. --- **`parentId`**: `ID` The location whose children are being ordered. Omit for the top level. # ReorderPurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/ReorderPurchaseOrderLine Reorder a purchase order line to a new index. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` --- **`reorderedPurchaseOrderLines`**: `[PurchaseOrderLine]` # ReorderPurchaseOrderLineInput Source: https://docs.firstresonance.io/api-reference/types/ReorderPurchaseOrderLineInput Input needed to reorder a purchase order line. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`position`**: `Int!` (required) # ReorderRunStepFields Source: https://docs.firstresonance.io/api-reference/types/ReorderRunStepFields Reorders runStepfields given a ReorderRunStepFieldsInput argument. **Kind**: `object` ## Fields **`fields`**: `[RunStepField]` # ReorderRunStepFieldsInput Source: https://docs.firstresonance.io/api-reference/types/ReorderRunStepFieldsInput Inputs needed to reorder RunStepFields. **Kind**: `input` ## Fields **`fields`**: `[UpdateFieldPositionInput]!` (required) --- **`runStepId`**: `ID!` (required) # ReorderRunSteps Source: https://docs.firstresonance.io/api-reference/types/ReorderRunSteps Reorders RunStep(s) given a ReorderRunStepInput argument. **Kind**: `object` ## Fields **`steps`**: `[RunStep]` # ReorderRunStepsInput Source: https://docs.firstresonance.io/api-reference/types/ReorderRunStepsInput Inputs needed to reorder RunSteps. **Kind**: `input` ## Fields **`parentRunStepId`**: `ID` --- **`runId`**: `ID` --- **`steps`**: `[UpdateStepPositionInput]!` (required) # ReorderStepFields Source: https://docs.firstresonance.io/api-reference/types/ReorderStepFields Reorders stepfields given a ReorderStepFieldsInput argument. **Kind**: `object` ## Fields **`fields`**: `[StepField]` # ReorderStepFieldsInput Source: https://docs.firstresonance.io/api-reference/types/ReorderStepFieldsInput Inputs needed to reorder StepFields. **Kind**: `input` ## Fields **`fields`**: `[UpdateFieldPositionInput]!` (required) --- **`stepId`**: `ID!` (required) # ReorderSteps Source: https://docs.firstresonance.io/api-reference/types/ReorderSteps Reorders Steps given a ReorderStepInput. **Kind**: `object` ## Fields **`steps`**: `[Step]` # ReorderStepsInput Source: https://docs.firstresonance.io/api-reference/types/ReorderStepsInput Inputs needed to ReorderSteps. **Kind**: `input` ## Fields **`parentStepId`**: `ID` --- **`procedureId`**: `ID` --- **`steps`**: `[UpdateStepPositionInput]!` (required) # ReplanPickRun Source: https://docs.firstresonance.io/api-reference/types/ReplanPickRun Rebuild the unwalked part of a run after stock moved. **Kind**: `object` ## Fields **`pickRun`**: `PickRun` # ReplanPickRunInput Source: https://docs.firstresonance.io/api-reference/types/ReplanPickRunInput Which run to re-plan. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`locationId`**: `ID` --- **`pickRunId`**: `ID!` (required) # RequestFileUploadUrl Source: https://docs.firstresonance.io/api-reference/types/RequestFileUploadUrl Get upload URL for file attachment. **Kind**: `object` ## Fields **`contentType`**: `String!` --- **`s3Key`**: `String!` --- **`uploadUrl`**: `String!` # RequestImportJobUploadUrl Source: https://docs.firstresonance.io/api-reference/types/RequestImportJobUploadUrl Get upload URL for import job. **Kind**: `object` ## Fields **`contentType`**: `String!` --- **`s3Key`**: `String!` --- **`uploadUrl`**: `String!` # RequireInstallIntentMatchSettings Source: https://docs.firstresonance.io/api-reference/types/RequireInstallIntentMatchSettings Settings for require_install_intent_match policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` --- **`mode`**: `String` # RequireInstallIntentMatchSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RequireInstallIntentMatchSettingsInput Input for require_install_intent_match policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`mode`**: `String` # RequireKitIntentMatchSettings Source: https://docs.firstresonance.io/api-reference/types/RequireKitIntentMatchSettings Settings for require_kit_intent_match policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` --- **`mode`**: `String` # RequireKitIntentMatchSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RequireKitIntentMatchSettingsInput Input for require_kit_intent_match policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`mode`**: `String` # RequiredAtRunCreateSettings Source: https://docs.firstresonance.io/api-reference/types/RequiredAtRunCreateSettings Settings for required_at_run_create policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` --- **`procedureTypes`**: `[String]` # RequiredAtRunCreateSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RequiredAtRunCreateSettingsInput Input for required_at_run_create policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`procedureTypes`**: `[String]` # RequiredAtRunStepStartSettings Source: https://docs.firstresonance.io/api-reference/types/RequiredAtRunStepStartSettings Settings for required_at_run_step_start policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` --- **`procedureTypes`**: `[String]` # RequiredAtRunStepStartSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RequiredAtRunStepStartSettingsInput Input for required_at_run_step_start policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`procedureTypes`**: `[String]` # RequiredOnRunIntentUpdateSettings Source: https://docs.firstresonance.io/api-reference/types/RequiredOnRunIntentUpdateSettings Settings for required_on_run_intent_update policy. **Kind**: `object` ## Fields **`enabled`**: `Boolean` --- **`procedureTypes`**: `[String]` # RequiredOnRunIntentUpdateSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RequiredOnRunIntentUpdateSettingsInput Input for required_on_run_intent_update policy. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`procedureTypes`**: `[String]` # Requirement Source: https://docs.firstresonance.io/api-reference/types/Requirement A graphql requirement object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`referenceName`**: `String` --- **`requirementType`**: `Requirementtypeenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RequirementEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RequirementEventFilter Source: https://docs.firstresonance.io/api-reference/types/RequirementEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`referenceName`**: `StringFilter` --- **`requirementType`**: `RequirementtypeenumFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # RequirementEvents Source: https://docs.firstresonance.io/api-reference/types/RequirementEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Requirement` --- **`oldValues`**: `Requirement` --- **`timestamp`**: `DateTime` # RequirementSortEnum Source: https://docs.firstresonance.io/api-reference/types/RequirementSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`REFERENCE_NAME_ASC`** **`REFERENCE_NAME_DESC`** **`REQUIREMENT_TYPE_ASC`** **`REQUIREMENT_TYPE_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RequirementToItemInput Source: https://docs.firstresonance.io/api-reference/types/RequirementToItemInput Inputs to attach a requirement to an object through its entity id. **Kind**: `input` ## Fields **`entityId`**: `Int!` (required) --- **`requirementId`**: `Int!` (required) # RequirementsConnection Source: https://docs.firstresonance.io/api-reference/types/RequirementsConnection **Kind**: `object` ## Fields **`edges`**: `[RequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RequirementsEdge Source: https://docs.firstresonance.io/api-reference/types/RequirementsEdge A Relay edge containing a `Requirements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Requirement` The item at the end of the edge # RequirementsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RequirementsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RequirementsInputFilters]` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RequirementsInputFilters]` --- **`referenceName`**: `StringFilter` --- **`requirementType`**: `RequirementtypeenumFilter` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Requirementtypeenum Source: https://docs.firstresonance.io/api-reference/types/Requirementtypeenum **Kind**: `enum` ## Values **`QUALITY_CLAUSE`** **`TERMS_AND_CONDITIONS`** # RequirementtypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/RequirementtypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Requirementtypeenum` --- **`gt`**: `Requirementtypeenum` --- **`gte`**: `Requirementtypeenum` --- **`ilike`**: `Requirementtypeenum` --- **`in`**: `[Requirementtypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Requirementtypeenum` --- **`lt`**: `Requirementtypeenum` --- **`lte`**: `Requirementtypeenum` --- **`neq`**: `Requirementtypeenum` --- **`notilike`**: `Requirementtypeenum` --- **`notlike`**: `Requirementtypeenum` # ResendInvite Source: https://docs.firstresonance.io/api-reference/types/ResendInvite Resend an invite to Ion given an id. **Kind**: `object` ## Fields **`invite`**: `Invite` # ResetChangeOrderApprovals Source: https://docs.firstresonance.io/api-reference/types/ResetChangeOrderApprovals Reset every approval request on an under-review change order to pending. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # ResetFurtherActionApprovals Source: https://docs.firstresonance.io/api-reference/types/ResetFurtherActionApprovals Send every approval request at a FurtherAction's current gate back to pending. **Kind**: `object` ## Fields **`furtherActionId`**: `Int` # ResetFurtherActionApprovalsInput Source: https://docs.firstresonance.io/api-reference/types/ResetFurtherActionApprovalsInput Inputs needed to reset the approvals on a FurtherAction. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`furtherActionId`**: `Int!` (required) # ResetIssueApprovals Source: https://docs.firstresonance.io/api-reference/types/ResetIssueApprovals Reset issue approvals given a ResetIssueApprovalsInput. **Kind**: `object` ## Fields **`issueId`**: `Int` # ResetIssueApprovalsInput Source: https://docs.firstresonance.io/api-reference/types/ResetIssueApprovalsInput Inputs needed to reset the approvals in an Issue. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`issueId`**: `Int!` (required) # ResetPurchaseOrderApprovalLevels Source: https://docs.firstresonance.io/api-reference/types/ResetPurchaseOrderApprovalLevels Resets a PurchaseOrder's approval levels. **Kind**: `object` ## Fields **`id`**: `Int` # ResetRedlineApprovals Source: https://docs.firstresonance.io/api-reference/types/ResetRedlineApprovals Reset redline approvals given a ResetRedlineApprovalsInput. **Kind**: `object` ## Fields **`redlineId`**: `Int` # ResetRedlineApprovalsInput Source: https://docs.firstresonance.io/api-reference/types/ResetRedlineApprovalsInput Inputs needed to reset the approvals on a redline. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`redlineId`**: `Int!` (required) # ResolvePartInventoryReview Source: https://docs.firstresonance.io/api-reference/types/ResolvePartInventoryReview Release, scrap, or delete a PartInventory awaiting human review. **Kind**: `object` ## Fields **`deletedId`**: `Int` --- **`partInventory`**: `PartInventory` # ResolvePartInventoryReviewInput Source: https://docs.firstresonance.io/api-reference/types/ResolvePartInventoryReviewInput Inputs needed to resolve inventory awaiting human review. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`resolution`**: `InventoryReviewResolution!` (required) # ResourceEnum Source: https://docs.firstresonance.io/api-reference/types/ResourceEnum **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS`** **`ACTIVE_REDLINES`** **`AI_CONSENT_WITHDRAWALS`** **`AI_TOS_ACCEPTANCES`** **`ANALYTICS_CREDENTIALS`** **`API_KEYS`** **`APPROVAL_LEVELS`** **`BARCODE_LABELS`** **`BARCODE_PATTERNS`** **`BARCODE_PRINT_REQUESTS`** **`BARCODE_SCAN_REQUESTS`** **`BARCODE_SCAN_REQUEST_ENTITIES`** **`BARCODE_TEMPLATES`** **`BUILD_REQUIREMENTS`** **`BUILD_REQUIREMENT_REFERENCE_DESIGNATORS`** **`BUILD_REQUIREMENT_SUBSTITUTES`** **`CHANGE_ORDERS`** **`CHANGE_ORDER_APPROVALS`** **`CHANGE_ORDER_APPROVAL_REQUESTS`** **`CHANGE_ORDER_APPROVAL_ROLES`** **`CHARGE_ACCOUNTS`** **`COMMENTS`** **`CONTACTS`** **`CURRENCIES`** **`CUSTOM_LOGGED_ACTIONS`** **`DATAGRID_COLUMNS`** **`DATAGRID_ROWS`** **`DATAGRID_VALUES`** **`FIELD_HISTORIES`** **`FILE_ATTACHMENTS`** **`FURTHER_ACTIONS`** **`FURTHER_ACTIONS_ATTRIBUTED_PARTS`** **`FURTHER_ACTIONS_ATTRIBUTED_USERS`** **`FURTHER_ACTIONS_ATTRIBUTES`** **`FURTHER_ACTION_APPROVALS`** **`FURTHER_ACTION_APPROVAL_REQUESTS`** **`FURTHER_ACTION_APPROVAL_ROLES`** **`FURTHER_ACTION_ISSUES`** **`FURTHER_ACTION_PARTS`** **`FURTHER_ACTION_RUNS`** **`IMPORT_JOBS`** **`INTENT_OPTIONS`** **`INVENTORY_HARD_CLAIMS`** **`INVITES`** **`ISSUES`** **`ISSUES_ATTRIBUTED_PARTS`** **`ISSUES_ATTRIBUTED_USERS`** **`ISSUES_ATTRIBUTES`** **`ISSUE_APPROVALS`** **`ISSUE_APPROVAL_REQUESTS`** **`ISSUE_DISPOSITION_TYPES`** **`ISSUE_DISPOSITION_TYPE_ROLES`** **`ISSUE_PART_INVENTORIES`** **`ISSUE_RELATIONS`** **`KIT_ELIGIBLE_INVENTORY`** **`LABELS`** **`LOCATIONS`** **`LOCATIONS_ATTRIBUTED_PARTS`** **`LOCATIONS_ATTRIBUTED_USERS`** **`LOCATIONS_ATTRIBUTES`** **`LOCATION_SUBTYPES`** **`LOGGED_ACTIONS`** **`LOGGED_ACTIONS_BASE`** **`LOGGED_ACTIONS_LEGACY`** **`MBOMS`** **`MBOMS_ATTRIBUTED_PARTS`** **`MBOMS_ATTRIBUTED_USERS`** **`MBOMS_ATTRIBUTES`** **`MBOM_APPROVALS`** **`MBOM_APPROVAL_REQUESTS`** **`MBOM_APPROVAL_ROLES`** **`MBOM_CHANGE_ORDER_LINES`** **`MBOM_CHANGE_ORDER_LINE_DIFFS`** **`MBOM_ITEM`** **`MBOM_ITEM_REFERENCE_DESIGNATORS`** **`MBOM_SUBSTITUTE`** **`MERGE_PART_INVENTORY_EVENTS`** **`MRP_JOBS`** **`OAUTH_APP_REGISTRATIONS`** **`OAUTH_REDIRECT_URIS`** **`ORGANIZATIONS`** **`ORGANIZATION_DOMAINS`** **`ORG_ATTRIBUTES`** **`ORIGIN_RUNS`** **`PARTS`** **`PARTS_ATTRIBUTED_PARTS`** **`PARTS_ATTRIBUTED_USERS`** **`PARTS_INVENTORIES_ATTRIBUTES`** **`PARTS_INVENTORY`** **`PARTS_INVENTORY_MAINTENANCE_STATUS`** **`PARTS_INVENTORY_MERGE_CANDIDATE_IDS`** **`PARTS_INVENTORY_ROLLED_UP_COSTS`** **`PARTS_KITS`** **`PART_ATTRIBUTES`** **`PART_ELIGIBLE_STOCK`** **`PART_INVENTORIES_ATTRIBUTED_PARTS`** **`PART_INVENTORIES_ATTRIBUTED_USERS`** **`PART_INVENTORY_BUILD_REQUIREMENTS`** **`PART_INVENTORY_HISTORY`** **`PART_INVENTORY_HISTORY_CURSORS`** **`PART_INVENTORY_HISTORY_SOURCE_EVENTS`** **`PART_INVENTORY_HISTORY_TRANSACTIONS`** **`PART_KITS_ATTRIBUTED_PARTS`** **`PART_KITS_ATTRIBUTED_USERS`** **`PART_KIT_ATTRIBUTES`** **`PART_KIT_INVENTORIES`** **`PART_KIT_ITEMS`** **`PART_KIT_ITEMS_ATTRIBUTED_PARTS`** **`PART_KIT_ITEMS_ATTRIBUTED_USERS`** **`PART_KIT_ITEM_ACCEPTABLE_PARTS`** **`PART_KIT_ITEM_ATTRIBUTES`** **`PART_LATEST_MBOMS`** **`PART_PART_SUBTYPES`** **`PART_PROCEDURES`** **`PART_SUBTYPES`** **`PART_UNIT_OF_MEASURE_CONFLICTS`** **`PERMISSION_GROUPS`** **`PERMISSION_GROUP_ROLES`** **`PICK_OVERRIDE_EVENTS`** **`PLANS`** **`PLANS_ATTRIBUTED_PARTS`** **`PLANS_ATTRIBUTED_USERS`** **`PLANS_ATTRIBUTES`** **`PLAN_CONSTRAINTS`** **`PLAN_CONSTRAINT_LOCATIONS`** **`PLAN_INPUTS`** **`PLAN_ITEMS`** **`PLAN_ITEM_ALLOCATIONS`** **`PLAN_ITEM_RESULTS`** **`PLAN_PLAN_ITEMS`** **`PLAN_RESERVATIONS`** **`PROCEDURES`** **`PROCEDURES_ATTRIBUTED_PARTS`** **`PROCEDURES_ATTRIBUTED_USERS`** **`PROCEDURES_ATTRIBUTES`** **`PROCEDURE_APPROVALS`** **`PROCEDURE_APPROVAL_REQUESTS`** **`PROCEDURE_APPROVAL_ROLES`** **`PROCEDURE_FAMILY_LABELS`** **`PROCEDURE_MBOMS`** **`PROCEDURE_MBOM_ITEMS`** **`PROCEDURE_REFERENCE_DESIGNATORS`** **`PROJECTS`** **`PURCHASE_ORDERS`** **`PURCHASE_ORDERS_ATTRIBUTED_PARTS`** **`PURCHASE_ORDERS_ATTRIBUTED_USERS`** **`PURCHASE_ORDERS_ATTRIBUTES`** **`PURCHASE_ORDER_APPROVALS`** **`PURCHASE_ORDER_APPROVAL_LEVELS`** **`PURCHASE_ORDER_APPROVAL_REQUESTS`** **`PURCHASE_ORDER_FEES`** **`PURCHASE_ORDER_LINES`** **`PURCHASE_ORDER_LINES_ATTRIBUTED_PARTS`** **`PURCHASE_ORDER_LINES_ATTRIBUTED_USERS`** **`PURCHASE_ORDER_LINES_ATTRIBUTES`** **`PURCHASE_ORDER_LINE_INVENTORIES`** **`QUANTITY_INSTALLED_PER_PARENT_PART_INVENTORY`** **`RECEIPTS`** **`RECEIPTS_ATTRIBUTED_PARTS`** **`RECEIPTS_ATTRIBUTED_USERS`** **`RECEIPTS_ATTRIBUTES`** **`RECEIPT_ITEMS`** **`RECOMMENDATIONS`** **`REDLINES`** **`REDLINE_APPROVALS`** **`REDLINE_APPROVAL_REQUESTS`** **`REDLINE_APPROVAL_ROLES`** **`REDLINE_ROLE_BASED_APPROVALS`** **`REDLINE_ROLE_BASED_APPROVAL_REQUESTS`** **`REFERENCE_DESIGNATOR_ASSIGNMENTS`** **`REQUIREMENTS`** **`REVIEWS`** **`REVIEW_REQUESTS`** **`ROLES`** **`RULE_EXECUTION_LOGS`** **`RULE_EXECUTION_LOG_RULES`** **`RULE_EXECUTION_LOG_TARGET_RECORDS`** **`RUNS`** **`RUNS_ATTRIBUTED_PARTS`** **`RUNS_ATTRIBUTED_USERS`** **`RUNS_ATTRIBUTES`** **`RUN_BATCHES`** **`RUN_STEPS`** **`RUN_STEPS_ATTRIBUTED_PARTS`** **`RUN_STEPS_ATTRIBUTED_USERS`** **`RUN_STEPS_ATTRIBUTES`** **`RUN_STEPS_DAGS`** **`RUN_STEPS_DESCENDANTS`** **`RUN_STEPS_FIELDS`** **`RUN_STEPS_SOURCE_STEP`** **`RUN_STEPS_STATUS_COUNTS`** **`RUN_STEP_BUILD_REQUIREMENT_SUBSTITUTES`** **`RUN_STEP_FIELD_VALIDATIONS`** **`RUN_STEP_PART_INVENTORIES`** **`RUN_STEP_SESSIONS`** **`SESSION_EVENTS`** **`SNAPSHOT_EXPORT_JOBS`** **`STEPS`** **`STEPS_ATTRIBUTED_PARTS`** **`STEPS_ATTRIBUTED_USERS`** **`STEPS_ATTRIBUTES`** **`STEPS_DAGS`** **`STEPS_DESCENDANTS`** **`STEPS_FIELDS`** **`STEPS_SOURCE_STEP`** **`STEP_APPROVALS`** **`STEP_APPROVAL_REQUESTS`** **`STEP_APPROVAL_ROLES`** **`STEP_FIELD_VALIDATIONS`** **`STEP_PART_REQUIREMENTS`** **`STEP_PROPOSALS`** **`STEP_ROLE_BASED_APPROVALS`** **`STEP_ROLE_BASED_APPROVAL_REQUESTS`** **`SUPPLIERS`** **`SUPPLIERS_ATTRIBUTED_PARTS`** **`SUPPLIERS_ATTRIBUTED_USERS`** **`SUPPLIERS_ATTRIBUTES`** **`SUPPLIER_PARTS`** **`TEAMS`** **`TEAM_ROLES`** **`TEAM_USERS`** **`TRANSACTION_AUDIT_CONTEXT`** **`UNITS_OF_MEASUREMENTS`** **`USERS`** **`USER_DEFINED_MESSAGES`** **`USER_NOTIFICATIONS`** **`USER_ROLES`** **`USER_SUBSCRIPTIONS`** **`USER_TRANSACTIONS`** **`VALIDATION_FUNCTIONS`** # ResourceEnumFilter Source: https://docs.firstresonance.io/api-reference/types/ResourceEnumFilter **Kind**: `input` ## Fields **`eq`**: `ResourceEnum` --- **`gt`**: `ResourceEnum` --- **`gte`**: `ResourceEnum` --- **`ilike`**: `ResourceEnum` --- **`in`**: `[ResourceEnum]` --- **`isnull`**: `Boolean` --- **`like`**: `ResourceEnum` --- **`lt`**: `ResourceEnum` --- **`lte`**: `ResourceEnum` --- **`neq`**: `ResourceEnum` --- **`notilike`**: `ResourceEnum` --- **`notlike`**: `ResourceEnum` # ResultToPlanItemInput Source: https://docs.firstresonance.io/api-reference/types/ResultToPlanItemInput Input object relating a result to a plan item through entity id. **Kind**: `input` ## Fields **`entityId`**: `Int!` (required) --- **`etag`**: `String!` (required) --- **`planItemId`**: `Int!` (required) # ReturnChangeOrderToDraft Source: https://docs.firstresonance.io/api-reference/types/ReturnChangeOrderToDraft Pull a change order back to draft and reopen the approval gate. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # Review Source: https://docs.firstresonance.io/api-reference/types/Review A Review related to a Procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` > Deprecated: "comment" is being deprecated in favor of "content" in order to include rich text content. --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `Review` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`replies`**: `[Review]` --- **`resolved`**: `Boolean` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReviewEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ReviewEventFilter Source: https://docs.firstresonance.io/api-reference/types/ReviewEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`procedureId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # ReviewEvents Source: https://docs.firstresonance.io/api-reference/types/ReviewEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Review` --- **`oldValues`**: `Review` --- **`timestamp`**: `DateTime` # ReviewRequest Source: https://docs.firstresonance.io/api-reference/types/ReviewRequest A request to review a Procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `Reviewstatusenum!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ReviewRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # ReviewRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`procedureId`**: `IDFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `ReviewstatusenumFilter` --- **`updatedById`**: `IDFilter` # ReviewRequestEvents Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ReviewRequest` --- **`oldValues`**: `ReviewRequest` --- **`timestamp`**: `DateTime` # ReviewRequestInput Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestInput Inputs needed for a ReviewRequest. **Kind**: `input` ## Fields **`procedureId`**: `ID!` (required) --- **`reviewerId`**: `ID!` (required) --- **`status`**: `Reviewstatusenum` # ReviewRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ReviewRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[ReviewRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ReviewRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestsEdge A Relay edge containing a `ReviewRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ReviewRequest` The item at the end of the edge # ReviewRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReviewRequestsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ReviewRequestsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ReviewRequestsInputFilters]` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `ReviewstatusenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # ReviewSortEnum Source: https://docs.firstresonance.io/api-reference/types/ReviewSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ReviewsConnection Source: https://docs.firstresonance.io/api-reference/types/ReviewsConnection **Kind**: `object` ## Fields **`edges`**: `[ReviewsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ReviewsEdge Source: https://docs.firstresonance.io/api-reference/types/ReviewsEdge A Relay edge containing a `Reviews` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Review` The item at the end of the edge # ReviewsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ReviewsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ReviewsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ReviewsInputFilters]` --- **`parentId`**: `IDFilter` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Reviewstatusenum Source: https://docs.firstresonance.io/api-reference/types/Reviewstatusenum **Kind**: `enum` ## Values **`APPROVED`** **`PENDING`** **`REJECTED`** # ReviewstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/ReviewstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Reviewstatusenum` --- **`gt`**: `Reviewstatusenum` --- **`gte`**: `Reviewstatusenum` --- **`ilike`**: `Reviewstatusenum` --- **`in`**: `[Reviewstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Reviewstatusenum` --- **`lt`**: `Reviewstatusenum` --- **`lte`**: `Reviewstatusenum` --- **`neq`**: `Reviewstatusenum` --- **`notilike`**: `Reviewstatusenum` --- **`notlike`**: `Reviewstatusenum` # RevokeInvite Source: https://docs.firstresonance.io/api-reference/types/RevokeInvite Revokes an invite to Ion given an id. **Kind**: `object` ## Fields **`invite`**: `Invite` # Role Source: https://docs.firstresonance.io/api-reference/types/Role Permissions given to Users. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_IssueApprovalRequestsCount`**: `Int` Optimized count of issueApprovalRequests. --- **`_IssueApprovalsCount`**: `Int` Optimized count of issueApprovals. --- **`_IssueDispositionTypeRolesCount`**: `Int` Optimized count of issueDispositionTypeRoles. --- **`_PermissionGroupRolesCount`**: `Int` Optimized count of permissionGroupRoles. --- **`_PermissionGroupsCount`**: `Int` Optimized count of permissionGroups. --- **`_TeamRolesCount`**: `Int` Optimized count of teamRoles. --- **`_TeamsCount`**: `Int` Optimized count of teams. --- **`_UserRolesCount`**: `Int` Optimized count of userRoles. --- **`_UsersCount`**: `Int` Optimized count of users. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`archived`**: `Boolean!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`issueApprovalRequests`**: `[IssueApprovalRequest]` **Arguments:** - `filters`: `IssueApprovalRequestsInputFilters` --- **`issueApprovals`**: `[IssueApproval]` **Arguments:** - `filters`: `IssueApprovalsInputFilters` --- **`issueDispositionTypeRoles`**: `[IssueDispositionTypeRole]` **Arguments:** - `filters`: `IssueDispositionTypeRolesInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`permissionGroups`**: `[PermissionGroup]` **Arguments:** - `filters`: `PermissionGroupsInputFilters` --- **`prettyStr`**: `String` --- **`teamRoles`**: `[TeamRole]` **Arguments:** - `filters`: `TeamRolesInputFilters` --- **`teams`**: `[Team]` **Arguments:** - `filters`: `TeamsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id --- **`userRoles`**: `[UserRole]` **Arguments:** - `filters`: `UserRolesInputFilters` --- **`users`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` # RoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/RoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`archived`**: `BooleanFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`updatedById`**: `IDFilter` # RoleEvents Source: https://docs.firstresonance.io/api-reference/types/RoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Role` --- **`oldValues`**: `Role` --- **`timestamp`**: `DateTime` # RoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/RoleSortEnum **Kind**: `enum` ## Values **`ARCHIVED_ASC`** **`ARCHIVED_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RoleToUserInput Source: https://docs.firstresonance.io/api-reference/types/RoleToUserInput Inputs needed to associate a role to an ION user. **Kind**: `input` ## Fields **`roleId`**: `Int!` (required) --- **`userId`**: `ID!` (required) # RolesConnection Source: https://docs.firstresonance.io/api-reference/types/RolesConnection **Kind**: `object` ## Fields **`edges`**: `[RolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RolesEdge Source: https://docs.firstresonance.io/api-reference/types/RolesEdge A Relay edge containing a `Roles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Role` The item at the end of the edge # RolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RolesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RolesInputFilters]` --- **`archived`**: `BooleanFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`issueApprovalRequests`**: `IssueApprovalRequestsInputFilters` --- **`issueApprovals`**: `IssueApprovalsInputFilters` --- **`issueDispositionTypeRoles`**: `IssueDispositionTypeRolesInputFilters` --- **`name`**: `StringFilter` --- **`or_`**: `[RolesInputFilters]` --- **`permissionGroups`**: `PermissionGroupsInputFilters` --- **`teamRoles`**: `TeamRolesInputFilters` --- **`teams`**: `TeamsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`userRoles`**: `UserRolesInputFilters` --- **`users`**: `UserInputFilters` # RotateSSOSigningCredentials Source: https://docs.firstresonance.io/api-reference/types/RotateSSOSigningCredentials Rotate IdP signing material (PEM cert or SAML metadata XML) on the org's SSO connection. **Kind**: `object` ## Fields **`rotation`**: `SSOSigningRotation` # Rule Source: https://docs.firstresonance.io/api-reference/types/Rule The graphene sqlalchemy object type for rules. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_ExecutionLogsCount`**: `Int` Optimized count of executionLogs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`aiDescription`**: `String` --- **`code`**: `String` --- **`codeHash`**: `String!` --- **`context`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`enabled`**: `Boolean` --- **`errorState`**: `RuleErrorState` --- **`eventType`**: `RuleEventType` --- **`executionLogs`**: `[RuleExecutionLog]` **Arguments:** - `filters`: `RuleExecutionLogsInputFilters` --- **`id`**: `Int` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`ruleType`**: `RuleType` --- **`status`**: `RuleStatus` --- **`target`**: `RuleTargetEnum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RuleEventFilter` --- **`title`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`version`**: `Int` # RuleDryRun Source: https://docs.firstresonance.io/api-reference/types/RuleDryRun What the real rules engine did with a draft Action. **Kind**: `object` ## Fields **`contextQuery`**: `String` The rebuilt query that ran, which is not the draft's own string. --- **`errorState`**: `String` block | warn, from the raised exception. --- **`evaluatedIds`**: `[Int]` --- **`message`**: `String` --- **`messageDropped`**: `Boolean` The Action supplies a message the engine discards, so whoever trips this Action sees only its title and not the reason. Static: it covers branches this run did not take. --- **`messageDroppedReason`**: `String` Why the message was discarded, or null when none was. --- **`observedContext`**: `JSONString` The context the Action's code actually received. Empty means the record was filtered out of the Action's own context query, so the Action is inert. --- **`outcome`**: `String` passed | blocked | warned | errored. 'errored' means the Action could not be run — it is not a violation. --- **`raised`**: `Boolean` Did the Action's code raise? --- **`saveError`**: `String` --- **`saveValid`**: `Boolean` Would this draft survive CreateRule? # RuleDryRunInput Source: https://docs.firstresonance.io/api-reference/types/RuleDryRunInput A draft Action that has not been saved. **Kind**: `input` ## Fields **`code`**: `String!` (required) --- **`context`**: `String!` (required) --- **`eventType`**: `RuleEventType!` (required) --- **`target`**: `RuleTargetEnum!` (required) --- **`title`**: `String` # RuleErrorState Source: https://docs.firstresonance.io/api-reference/types/RuleErrorState Enum for rules error states. **Kind**: `enum` ## Values **`ALLOW`** **`BLOCK`** # RuleErrorStateFilter Source: https://docs.firstresonance.io/api-reference/types/RuleErrorStateFilter **Kind**: `input` ## Fields **`eq`**: `RuleErrorState` --- **`gt`**: `RuleErrorState` --- **`gte`**: `RuleErrorState` --- **`ilike`**: `RuleErrorState` --- **`in`**: `[RuleErrorState]` --- **`isnull`**: `Boolean` --- **`like`**: `RuleErrorState` --- **`lt`**: `RuleErrorState` --- **`lte`**: `RuleErrorState` --- **`neq`**: `RuleErrorState` --- **`notilike`**: `RuleErrorState` --- **`notlike`**: `RuleErrorState` # RuleEventFilter Source: https://docs.firstresonance.io/api-reference/types/RuleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`code`**: `StringFilter` --- **`codeHash`**: `StringFilter` --- **`context`**: `StringFilter` --- **`createdById`**: `IDFilter` --- **`enabled`**: `BooleanFilter` --- **`errorState`**: `RuleErrorStateFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`ruleType`**: `RuleTypeFilter` --- **`status`**: `RuleStatusFilter` --- **`target`**: `RuleTargetEnumFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # RuleEventType Source: https://docs.firstresonance.io/api-reference/types/RuleEventType Enum for rule event types. **Kind**: `enum` ## Values **`CREATE`** **`DELETE`** **`UPDATE`** # RuleEventTypeFilter Source: https://docs.firstresonance.io/api-reference/types/RuleEventTypeFilter **Kind**: `input` ## Fields **`eq`**: `RuleEventType` --- **`gt`**: `RuleEventType` --- **`gte`**: `RuleEventType` --- **`ilike`**: `RuleEventType` --- **`in`**: `[RuleEventType]` --- **`isnull`**: `Boolean` --- **`like`**: `RuleEventType` --- **`lt`**: `RuleEventType` --- **`lte`**: `RuleEventType` --- **`neq`**: `RuleEventType` --- **`notilike`**: `RuleEventType` --- **`notlike`**: `RuleEventType` # RuleEvents Source: https://docs.firstresonance.io/api-reference/types/RuleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Rule` --- **`oldValues`**: `Rule` --- **`timestamp`**: `DateTime` # RuleExecutionLog Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLog GraphQL type for ironclad rule execution logs. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allRuleIds`**: `[Int]` --- **`context`**: `JSONString` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`errorMessage`**: `String` --- **`executableCode`**: `String!` --- **`executionTimeMs`**: `Int` --- **`frontendRequestId`**: `String` --- **`prettyStr`**: `String` --- **`raisedRule`**: `Rule` **Arguments:** - `filters`: `RulesInputFilters` --- **`raisedRuleId`**: `Int` --- **`ruleEvent`**: `RuleEventType` --- **`ruleTarget`**: `RuleTargetEnum` --- **`rules`**: `[Rule]` **Arguments:** - `filters`: `RulesInputFilters` --- **`targetRecordIds`**: `[String]` --- **`targetRecords`**: `[RuleExecutionLogTargetRecord]` **Arguments:** - `filters`: `RuleExecutionLogTargetRecordsInputFilters` --- **`uuid`**: `UUID` # RuleExecutionLogRule Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogRule GraphQL type for rule execution log entries (per-rule metadata). **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`executionLog`**: `RuleExecutionLog` **Arguments:** - `filters`: `RuleExecutionLogsInputFilters` --- **`executionOrder`**: `Int` --- **`id`**: `Int!` --- **`isRaisedRule`**: `Boolean!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`rule`**: `Rule` **Arguments:** - `filters`: `RulesInputFilters` --- **`ruleExecutionLogId`**: `Int!` --- **`ruleId`**: `Int!` # RuleExecutionLogSortEnum Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogSortEnum **Kind**: `enum` ## Values **`ALL_RULE_IDS_ASC`** **`ALL_RULE_IDS_DESC`** **`CONTEXT_ASC`** **`CONTEXT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ERROR_MESSAGE_ASC`** **`ERROR_MESSAGE_DESC`** **`EXECUTABLE_CODE_ASC`** **`EXECUTABLE_CODE_DESC`** **`EXECUTION_TIME_MS_ASC`** **`EXECUTION_TIME_MS_DESC`** **`FRONTEND_REQUEST_ID_ASC`** **`FRONTEND_REQUEST_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_WARNING_ASC`** **`IS_WARNING_DESC`** **`RAISED_RULE_ID_ASC`** **`RAISED_RULE_ID_DESC`** **`RULE_EVENT_ASC`** **`RULE_EVENT_DESC`** **`RULE_TARGET_ASC`** **`RULE_TARGET_DESC`** **`TARGET_RECORD_IDS_ASC`** **`TARGET_RECORD_IDS_DESC`** **`UUID_ASC`** **`UUID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** # RuleExecutionLogTargetRecord Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogTargetRecord GraphQL type for rule execution log targets. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`executionLog`**: `RuleExecutionLog` **Arguments:** - `filters`: `RuleExecutionLogsInputFilters` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`ruleExecutionLogId`**: `ID!` --- **`target`**: `String!` --- **`targetRecordId`**: `String!` # RuleExecutionLogTargetRecordsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogTargetRecordsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`and_`**: `[RuleExecutionLogTargetRecordsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IntFilter` --- **`executionLog`**: `RuleExecutionLogsInputFilters` --- **`id`**: `IntFilter` --- **`or_`**: `[RuleExecutionLogTargetRecordsInputFilters]` --- **`ruleExecutionLogId`**: `IDFilter` --- **`target`**: `StringFilter` --- **`targetRecordId`**: `StringFilter` # RuleExecutionLogsConnection Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogsConnection **Kind**: `object` ## Fields **`edges`**: `[RuleExecutionLogsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RuleExecutionLogsEdge Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogsEdge A Relay edge containing a `RuleExecutionLogs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RuleExecutionLog` The item at the end of the edge # RuleExecutionLogsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`and_`**: `[RuleExecutionLogsInputFilters]` --- **`context`**: `JSONStringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IntFilter` --- **`errorMessage`**: `StringFilter` --- **`executableCode`**: `StringFilter` --- **`executionTimeMs`**: `IntFilter` --- **`frontendRequestId`**: `StringFilter` --- **`or_`**: `[RuleExecutionLogsInputFilters]` --- **`raisedRule`**: `RulesInputFilters` --- **`raisedRuleId`**: `IntFilter` --- **`ruleEvent`**: `RuleEventTypeFilter` --- **`ruleTarget`**: `RuleTargetEnumFilter` --- **`rules`**: `RulesInputFilters` --- **`targetRecords`**: `RuleExecutionLogTargetRecordsInputFilters` --- **`uuid`**: `UUIDFilter` # RuleExecutionLogsMetrics Source: https://docs.firstresonance.io/api-reference/types/RuleExecutionLogsMetrics Metrics for rule execution logs. **Kind**: `object` ## Fields **`errorCount`**: `Int` Number of rule execution logs with errors. --- **`totalCount`**: `Int` Total number of rule execution logs. # RuleSettings Source: https://docs.firstresonance.io/api-reference/types/RuleSettings Organization settings related to rules. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`enabled`**: `Boolean` --- **`errorState`**: `RuleErrorState` --- **`errorStateMessage`**: `String` # RuleSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RuleSettingsInput Input settings related to rules. **Kind**: `input` ## Fields **`enabled`**: `Boolean` --- **`errorState`**: `RuleErrorState` --- **`errorStateMessage`**: `String` # RuleSortEnum Source: https://docs.firstresonance.io/api-reference/types/RuleSortEnum **Kind**: `enum` ## Values **`CODE_ASC`** **`CODE_DESC`** **`CODE_HASH_ASC`** **`CODE_HASH_DESC`** **`CONTEXT_ASC`** **`CONTEXT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENABLED_ASC`** **`ENABLED_DESC`** **`ERROR_STATE_ASC`** **`ERROR_STATE_DESC`** **`EVENT_TYPE_ASC`** **`EVENT_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`RULE_TYPE_ASC`** **`RULE_TYPE_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TARGET_ASC`** **`TARGET_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VERSION_ASC`** **`VERSION_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RuleStatus Source: https://docs.firstresonance.io/api-reference/types/RuleStatus Enum for rules event types. **Kind**: `enum` ## Values **`ACTIVE`** **`DISABLED`** **`ERROR`** **`UNINITIALIZED`** **`VALIDATING`** # RuleStatusFilter Source: https://docs.firstresonance.io/api-reference/types/RuleStatusFilter **Kind**: `input` ## Fields **`eq`**: `RuleStatus` --- **`gt`**: `RuleStatus` --- **`gte`**: `RuleStatus` --- **`ilike`**: `RuleStatus` --- **`in`**: `[RuleStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `RuleStatus` --- **`lt`**: `RuleStatus` --- **`lte`**: `RuleStatus` --- **`neq`**: `RuleStatus` --- **`notilike`**: `RuleStatus` --- **`notlike`**: `RuleStatus` # RuleTargetEnum Source: https://docs.firstresonance.io/api-reference/types/RuleTargetEnum **Kind**: `enum` ## Values **`ABOMINSTALLATION`** **`APPROVALLEVEL`** **`BARCODELABEL`** **`BARCODEPATTERN`** **`BARCODEPRINTREQUEST`** **`BARCODESCANREQUEST`** **`BARCODETEMPLATE`** **`BUILDREQUIREMENT`** **`BUILDREQUIREMENTREFERENCEDESIGNATOR`** **`BUILDREQUIREMENTSUBSTITUTE`** **`CHARGEACCOUNT`** **`COMMENT`** **`CONTACT`** **`CURRENCY`** **`DATAGRIDCOLUMN`** **`DATAGRIDROW`** **`DATAGRIDVALUE`** **`ENTITIESREQUIREMENT`** **`FURTHERACTION`** **`FURTHERACTIONAPPROVAL`** **`FURTHERACTIONAPPROVALREQUEST`** **`IMPORTJOB`** **`INTENTOPTION`** **`INVITE`** **`ISSUE`** **`ISSUEAPPROVAL`** **`ISSUEAPPROVALREQUEST`** **`ISSUEDISPOSITIONTYPE`** **`ISSUEPARTINVENTORY`** **`LABEL`** **`LOCATION`** **`LOCATIONSUBTYPE`** **`MBOM`** **`MBOMAPPROVAL`** **`MBOMAPPROVALREQUEST`** **`MBOMITEM`** **`MBOMITEMREFERENCEDESIGNATOR`** **`MBOMSUBSTITUTE`** **`MRPJOB`** **`ORGANIZATIONDOMAIN`** **`PART`** **`PARTINVENTORY`** **`PARTKIT`** **`PARTKITINVENTORY`** **`PARTKITITEM`** **`PARTPROCEDURE`** **`PARTSUBTYPE`** **`PERMISSIONGROUP`** **`PLAN`** **`PLANCONSTRAINT`** **`PLANINPUT`** **`PLANITEM`** **`PLANRESERVATION`** **`PROCEDURE`** **`PROCEDUREAPPROVAL`** **`PROCEDUREAPPROVALREQUEST`** **`PROJECT`** **`PURCHASEORDER`** **`PURCHASEORDERAPPROVAL`** **`PURCHASEORDERAPPROVALLEVEL`** **`PURCHASEORDERAPPROVALREQUEST`** **`PURCHASEORDERFEE`** **`PURCHASEORDERLINE`** **`RECEIPT`** **`RECEIPTITEM`** **`REDLINE`** **`REDLINEAPPROVAL`** **`REDLINEAPPROVALREQUEST`** **`REDLINEROLEBASEDAPPROVAL`** **`REDLINEROLEBASEDAPPROVALREQUEST`** **`REQUIREMENT`** **`REVIEW`** **`REVIEWREQUEST`** **`ROLE`** **`RUN`** **`RUNBATCH`** **`RUNSTEP`** **`RUNSTEPEDGE`** **`RUNSTEPFIELD`** **`RUNSTEPFIELDVALIDATION`** **`SESSION`** **`SNAPSHOTEXPORTJOB`** **`STEP`** **`STEPAPPROVAL`** **`STEPAPPROVALREQUEST`** **`STEPEDGE`** **`STEPFIELD`** **`STEPFIELDVALIDATION`** **`STEPPARTREQUIREMENT`** **`STEPPROPOSAL`** **`STEPROLEBASEDAPPROVAL`** **`STEPROLEBASEDAPPROVALREQUEST`** **`SUPPLIER`** **`SUPPLIERPART`** **`TEAM`** **`UNITOFMEASUREMENT`** **`USER`** **`USERDEFINEDMESSAGE`** **`USERNOTIFICATION`** **`USERSUBSCRIPTION`** **`VALIDATIONFUNCTION`** **`WEBHOOKEVENT`** **`WEBHOOKHEADER`** **`WEBHOOKRECEIVER`** **`WEBHOOKSUBSCRIPTION`** # RuleTargetEnumFilter Source: https://docs.firstresonance.io/api-reference/types/RuleTargetEnumFilter **Kind**: `input` ## Fields **`eq`**: `RuleTargetEnum` --- **`gt`**: `RuleTargetEnum` --- **`gte`**: `RuleTargetEnum` --- **`ilike`**: `RuleTargetEnum` --- **`in`**: `[RuleTargetEnum]` --- **`isnull`**: `Boolean` --- **`like`**: `RuleTargetEnum` --- **`lt`**: `RuleTargetEnum` --- **`lte`**: `RuleTargetEnum` --- **`neq`**: `RuleTargetEnum` --- **`notilike`**: `RuleTargetEnum` --- **`notlike`**: `RuleTargetEnum` # RuleType Source: https://docs.firstresonance.io/api-reference/types/RuleType Enum for rule types. **Kind**: `enum` ## Values **`VALIDATION`** # RuleTypeFilter Source: https://docs.firstresonance.io/api-reference/types/RuleTypeFilter **Kind**: `input` ## Fields **`eq`**: `RuleType` --- **`gt`**: `RuleType` --- **`gte`**: `RuleType` --- **`ilike`**: `RuleType` --- **`in`**: `[RuleType]` --- **`isnull`**: `Boolean` --- **`like`**: `RuleType` --- **`lt`**: `RuleType` --- **`lte`**: `RuleType` --- **`neq`**: `RuleType` --- **`notilike`**: `RuleType` --- **`notlike`**: `RuleType` # RulesConnection Source: https://docs.firstresonance.io/api-reference/types/RulesConnection **Kind**: `object` ## Fields **`edges`**: `[RulesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RulesEdge Source: https://docs.firstresonance.io/api-reference/types/RulesEdge A Relay edge containing a `Rules` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Rule` The item at the end of the edge # RulesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RulesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RulesInputFilters]` --- **`code`**: `StringFilter` --- **`codeHash`**: `StringFilter` --- **`context`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`enabled`**: `BooleanFilter` --- **`errorState`**: `RuleErrorStateFilter` --- **`eventType`**: `RuleEventTypeFilter` --- **`executionLogs`**: `RuleExecutionLogsInputFilters` --- **`id`**: `IDFilter` --- **`or_`**: `[RulesInputFilters]` --- **`ruleType`**: `RuleTypeFilter` --- **`status`**: `RuleStatusFilter` --- **`target`**: `RuleTargetEnumFilter` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # Run Source: https://docs.firstresonance.io/api-reference/types/Run A Run of a given released Procedure. **Kind**: `object` ## Fields **`Attributes`**: `[RunAttribute]` **Arguments:** - `filters`: `RunAttributesInputFilters` --- **`ExportControlled`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_FurtherActionsCount`**: `Int` Optimized count of furtherActions. --- **`_IssuesCount`**: `Int` --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_LocationsCount`**: `Int` --- **`_OriginPartInventoriesCount`**: `Int` Optimized count of originPartInventories. --- **`_PartKitsCount`**: `Int` Optimized count of partKits. --- **`_RedlinesCount`**: `Int` --- **`_SessionsCount`**: `Int` --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomCompletionJustification`**: `String` --- **`abomCompletionJustificationAt`**: `DateTime` --- **`abomCompletionJustificationBy`**: `Int` --- **`abomCompletionJustificationUser`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`abomJustificationSubmitted`**: `Boolean!` --- **`allBatchedSiblings`**: `[Run]` --- **`archived`**: `Boolean!` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[RunAttributedPart]` **Arguments:** - `filters`: `RunAttributedPartsInputFilters` --- **`attributedUsers`**: `[RunAttributedUser]` **Arguments:** - `filters`: `RunAttributedUsersInputFilters` --- **`attributes`**: `[RunAttribute]` --- **`batchAdoptedSiblings`**: `[Run]` --- **`batchSiblings`**: `[Run]` --- **`batched`**: `Boolean` --- **`calculatedLeadTime`**: `Int` --- **`comments`**: `[Comment]` --- **`completedBy`**: `User` --- **`completedQuantity`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`dueDate`**: `DateTime` --- **`endTime`**: `DateTime` End time is calculated from the latest run step end time. --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`exportControlled`**: `Boolean` --- **`fileAttachments`**: `[FileAttachment]` --- **`furtherActions`**: `[FurtherAction]` **Arguments:** - `filters`: `FurtherActionsInputFilters` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isComplexAssembly`**: `Boolean` --- **`isOpen`**: `Boolean` --- **`issues`**: `[Issue]` --- **`jiraIssueKey`**: `String` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`locations`**: `[Location]` --- **`originPartInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` --- **`partInventory`**: `PartInventory` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` --- **`partKits`**: `[PartKit]` **Arguments:** - `filters`: `PartKitsInputFilters` --- **`percentComplete`**: `Int` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureId`**: `Int` --- **`quantity`**: `Int` --- **`redlines`**: `[Redline]` --- **`resultsLink`**: `String` --- **`runBatch`**: `RunBatch` **Arguments:** - `filters`: `RunBatchesInputFilters` --- **`runBatchId`**: `Int` --- **`scheduledEnd`**: `DateTime` Scheduled end is calculated from the latest scheduled run step. --- **`scheduledStart`**: `DateTime` --- **`sessions`**: `[Session]` --- **`startTime`**: `DateTime` Start time is calculated from the earliest run step start time. --- **`startedBy`**: `User` --- **`status`**: `RunStatus` --- **`steps`**: `[RunStep]` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunEventFilter` --- **`title`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RunAttribute Source: https://docs.firstresonance.io/api-reference/types/RunAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # RunAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`runId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # RunAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/RunAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunAttribute` --- **`oldValues`**: `RunAttribute` --- **`timestamp`**: `DateTime` # RunAttributedPart Source: https://docs.firstresonance.io/api-reference/types/RunAttributedPart Auto-generated GQL type for RunAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # RunAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[RunAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[RunAttributedPartsInputFilters]` # RunAttributedUser Source: https://docs.firstresonance.io/api-reference/types/RunAttributedUser Auto-generated GQL type for RunAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # RunAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[RunAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[RunAttributedUsersInputFilters]` # RunAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[RunAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[RunAttributesInputFilters]` --- **`run`**: `RunsInputFilters` --- **`runId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # RunBatch Source: https://docs.firstresonance.io/api-reference/types/RunBatch GraphQL query object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RunsCount`**: `Int` Optimized count of runs. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`runs`**: `[Run]` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunBatchEventFilter` --- **`title`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RunBatchEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunBatchEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # RunBatchEvents Source: https://docs.firstresonance.io/api-reference/types/RunBatchEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunBatch` --- **`oldValues`**: `RunBatch` --- **`timestamp`**: `DateTime` # RunBatchSortEnum Source: https://docs.firstresonance.io/api-reference/types/RunBatchSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RunBatchesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunBatchesInputFilters GraphQL input filters. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RunBatchesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RunBatchesInputFilters]` --- **`runs`**: `RunsInputFilters` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RunBatchsConnection Source: https://docs.firstresonance.io/api-reference/types/RunBatchsConnection **Kind**: `object` ## Fields **`edges`**: `[RunBatchsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RunBatchsEdge Source: https://docs.firstresonance.io/api-reference/types/RunBatchsEdge A Relay edge containing a `RunBatchs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RunBatch` The item at the end of the edge # RunCancellationDisposition Source: https://docs.firstresonance.io/api-reference/types/RunCancellationDisposition Human disposition for a terminal run's output inventory. **Kind**: `enum` ## Values **`DEFER`** **`DELETE`** **`RELEASE`** **`SCRAP`** # RunEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`ExportControlled`**: `BooleanFilter` --- **`Updated`**: `DateTimeFilter` --- **`abomCompletionJustification`**: `StringFilter` --- **`abomCompletionJustificationAt`**: `DateTimeFilter` --- **`abomCompletionJustificationBy`**: `IDFilter` --- **`abomJustificationSubmitted`**: `BooleanFilter` --- **`actor`**: `UserInputFilters` --- **`archived`**: `BooleanFilter` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`completedQuantity`**: `FloatFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`dueDate`**: `DateTimeFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IDFilter` --- **`isComplexAssembly`**: `BooleanFilter` --- **`jiraIssueKey`**: `StringFilter` --- **`partId`**: `IDFilter` --- **`partInventoryId`**: `IDFilter` --- **`procedureId`**: `IDFilter` --- **`quantity`**: `IntFilter` --- **`resultsLink`**: `StringFilter` --- **`runBatchId`**: `IDFilter` --- **`scheduledEnd`**: `DateTimeFilter` --- **`startTime`**: `DateTimeFilter` --- **`status`**: `RunStatusFilter` --- **`title`**: `StringFilter` --- **`updatedById`**: `IDFilter` # RunEvents Source: https://docs.firstresonance.io/api-reference/types/RunEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Run` --- **`oldValues`**: `Run` --- **`timestamp`**: `DateTime` # RunIntentSideEffectSettings Source: https://docs.firstresonance.io/api-reference/types/RunIntentSideEffectSettings Settings for run_intent_side_effect policy. **Kind**: `object` ## Fields **`downgradeInventoryOnMismatch`**: `Boolean` --- **`enabled`**: `Boolean` # RunIntentSideEffectSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RunIntentSideEffectSettingsInput Input for run_intent_side_effect policy. **Kind**: `input` ## Fields **`downgradeInventoryOnMismatch`**: `Boolean` --- **`enabled`**: `Boolean` # RunReferenceDesignatorAssignment Source: https://docs.firstresonance.io/api-reference/types/RunReferenceDesignatorAssignment A reference-designator → run-step assignment (the reconcile-managed shadow). **Kind**: `object` ## Fields **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirementId`**: `Int!` --- **`buildRequirementReferenceDesignatorId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`divergedFromOrigin`**: `Boolean!` --- **`id`**: `ID` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`runStepId`**: `Int!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RunReferenceDesignatorAssignmentsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunReferenceDesignatorAssignmentsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_deleted`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RunReferenceDesignatorAssignmentsInputFilters]` --- **`buildRequirementId`**: `IDFilter` --- **`buildRequirementReferenceDesignatorId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`divergedFromOrigin`**: `BooleanFilter` --- **`or_`**: `[RunReferenceDesignatorAssignmentsInputFilters]` --- **`runStepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RunSettings Source: https://docs.firstresonance.io/api-reference/types/RunSettings Organization settings related to runs. **Kind**: `object` ## Fields **`allowCompletionWithPartJustification`**: `Boolean` --- **`attributes`**: `[AttributeSettings]` --- **`autoAssignToCreator`**: `Boolean` --- **`enforceAllPartsInstalledForCompletion`**: `Boolean` --- **`enforceIssuesResolvedBeforeCompletion`**: `Boolean` --- **`enforceOutgoingLocationForCompletion`**: `Boolean` --- **`enforcePeerSignoff`**: `Boolean` --- **`enforceTitleTemplate`**: `Boolean` --- **`enforceValidPartProcedure`**: `Boolean` --- **`requireProcedureForRunCreation`**: `Boolean` --- **`titleTemplate`**: `String` # RunSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RunSettingsInput Input settings related to runs. **Kind**: `input` ## Fields **`allowCompletionWithPartJustification`**: `Boolean` --- **`autoAssignToCreator`**: `Boolean` --- **`enforceAllPartsInstalledForCompletion`**: `Boolean` --- **`enforceIssuesResolvedBeforeCompletion`**: `Boolean` --- **`enforceOutgoingLocationForCompletion`**: `Boolean` --- **`enforcePeerSignoff`**: `Boolean` --- **`enforceTitleTemplate`**: `Boolean` --- **`enforceValidPartProcedure`**: `Boolean` --- **`requireProcedureForRunCreation`**: `Boolean` --- **`titleTemplate`**: `String` # RunSortEnum Source: https://docs.firstresonance.io/api-reference/types/RunSortEnum **Kind**: `enum` ## Values **`ABOM_COMPLETION_JUSTIFICATION_ASC`** **`ABOM_COMPLETION_JUSTIFICATION_AT_ASC`** **`ABOM_COMPLETION_JUSTIFICATION_AT_DESC`** **`ABOM_COMPLETION_JUSTIFICATION_BY_ASC`** **`ABOM_COMPLETION_JUSTIFICATION_BY_DESC`** **`ABOM_COMPLETION_JUSTIFICATION_DESC`** **`ABOM_JUSTIFICATION_SUBMITTED_ASC`** **`ABOM_JUSTIFICATION_SUBMITTED_DESC`** **`ARCHIVED_ASC`** **`ARCHIVED_DESC`** **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`COMPLETED_QUANTITY_ASC`** **`COMPLETED_QUANTITY_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`DUE_DATE_ASC`** **`DUE_DATE_DESC`** **`END_TIME_ASC`** **`END_TIME_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`IS_COMPLEX_ASSEMBLY_ASC`** **`IS_COMPLEX_ASSEMBLY_DESC`** **`JIRA_ISSUE_KEY_ASC`** **`JIRA_ISSUE_KEY_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`RESULTS_LINK_ASC`** **`RESULTS_LINK_DESC`** **`RUN_BATCH_ID_ASC`** **`RUN_BATCH_ID_DESC`** **`SCHEDULED_END_ASC`** **`SCHEDULED_END_DESC`** **`START_TIME_ASC`** **`START_TIME_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_EXPORT_CONTROLLED_ASC`** **`_EXPORT_CONTROLLED_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RunStatus Source: https://docs.firstresonance.io/api-reference/types/RunStatus **Kind**: `enum` ## Values **`CANCELED`** **`COMPLETE`** **`FAILED`** **`HOLD`** **`IN_PROGRESS`** **`PARTIAL_COMPLETE`** **`REDLINE`** **`TODO`** # RunStatusFilter Source: https://docs.firstresonance.io/api-reference/types/RunStatusFilter **Kind**: `input` ## Fields **`eq`**: `RunStatus` --- **`gt`**: `RunStatus` --- **`gte`**: `RunStatus` --- **`ilike`**: `RunStatus` --- **`in`**: `[RunStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `RunStatus` --- **`lt`**: `RunStatus` --- **`lte`**: `RunStatus` --- **`neq`**: `RunStatus` --- **`notilike`**: `RunStatus` --- **`notlike`**: `RunStatus` # RunStep Source: https://docs.firstresonance.io/api-reference/types/RunStep Steps related to a particular Run. **Kind**: `object` ## Fields **`Attributes`**: `[RunStepAttribute]` **Arguments:** - `filters`: `RunStepAttributesInputFilters` --- **`Parent`**: `String` --- **`Sessions`**: `[SessionEvent]` > Deprecated: The Sessions field is being deprecated in favor of the sessions field. --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AllChildrenCount`**: `Int` --- **`_AllParentsCount`**: `Int` --- **`_AncestorRunStepsCount`**: `Int` Optimized count of ancestorRunSteps. --- **`_AssigneesCount`**: `Int` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_BlockingIssuesCount`**: `Int` Optimized count of blockingIssues. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_DatagridColumnsCount`**: `Int` Optimized count of datagridColumns. --- **`_DatagridRowsCount`**: `Int` Optimized count of datagridRows. --- **`_DescendantRunStepsCount`**: `Int` Optimized count of descendantRunSteps. --- **`_DownstreamCount`**: `Int` Optimized count of downstream. --- **`_FieldsCount`**: `Int` Optimized count of fields. --- **`_FileAttachmentsCount`**: `Int` Optimized count of fileAttachments. --- **`_IssuesCount`**: `Int` Optimized count of issues. --- **`_MustCloseByLinkedIssuesCount`**: `Int` Optimized count of mustCloseByLinkedIssues. --- **`_PartInventoriesCount`**: `Int` Optimized count of partInventories. --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_RedlinesCount`**: `Int` Optimized count of redlines. --- **`_RunStepBuildRequirementsCount`**: `Int` Optimized count of runStepBuildRequirements. --- **`_SessionsCount`**: `Int` Optimized count of sessions. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_UpstreamCount`**: `Int` Optimized count of upstream. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`activeRedline`**: `Redline` --- **`activeRedlineId`**: `Int` --- **`allBatchedSiblings`**: `[RunStep]` --- **`allChildren`**: `[RunStep]` --- **`allParents`**: `[RunStep]` --- **`ancestorRunSteps`**: `[RunStep]` --- **`assets`**: `[FileAttachment]` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`attributedParts`**: `[RunStepAttributedPart]` **Arguments:** - `filters`: `RunStepAttributedPartsInputFilters` --- **`attributedUsers`**: `[RunStepAttributedUser]` **Arguments:** - `filters`: `RunStepAttributedUsersInputFilters` --- **`attributes`**: `[RunStepAttribute]` --- **`availableToWork`**: `Boolean` --- **`batchAdoptedSiblings`**: `[RunStep]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[RunStep]` --- **`batched`**: `Boolean` --- **`blockingIssues`**: `[Issue]` --- **`calculatedLeadTime`**: `Int` --- **`canComplete`**: `Boolean!` True when this step can transition to COMPLETE — every step-level completion validator passes (required installs incl. batch siblings, required fields, child steps complete/canceled, required datagrid rows, field validations). False for statuses that cannot transition to COMPLETE. Run-completion gates are not evaluated: completing the run's last step can still be rejected by run-level ABOM part checks or user-defined rules (write/commit-time only). --- **`comments`**: `[Comment]` --- **`completedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`completedById`**: `Int` --- **`content`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`datagrid`**: `DataGrid` > Deprecated: Deprecated --- **`datagridColumns`**: `DatagridColumnsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridColumnsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridColumnSortEnum]` --- **`datagridRows`**: `DatagridRowsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridRowsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridRowSortEnum]` --- **`descendantRunSteps`**: `[RunStep]` --- **`displayPdf`**: `Boolean!` --- **`downstream`**: `[RunStepsEdge]` **Arguments:** - `filters`: `RunStepsEdgesInputFilters` --- **`downstreamStepIds`**: `[Int]` --- **`editable`**: `String` --- **`endTime`**: `DateTime` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fields`**: `[RunStepField]` **Arguments:** - `filters`: `RunStepFieldInputFilters` --- **`fileAttachments`**: `[FileAttachment]` --- **`fullPosition`**: `String` --- **`hashCode`**: `String` --- **`id`**: `Int!` --- **`isChildStandardStep`**: `Boolean` --- **`isLatched`**: `Boolean` True if the run step has been latched to a specific standard step version. A latched step has been separated from its standard step dependency and locked to a specific version. --- **`isOutsideProcess`**: `Boolean!` --- **`isStandardStep`**: `Boolean!` --- **`issues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`leadTime`**: `Int` --- **`location`**: `Location` Return location relationship. **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` Return location foreign key. --- **`mustCloseByLinkedIssues`**: `[Issue]` **Arguments:** - `filters`: `IssueInputFilters` --- **`originStep`**: `Step` Return step which self was generated from. **Arguments:** - `filters`: `StepsFilters` --- **`originStepId`**: `Int` Return step id from which a copied step originated. --- **`pages`**: `[Int]` --- **`parent`**: `RunStep` --- **`parentId`**: `Int` Return self referential parent foreign key. --- **`parentIds`**: `[Int]` --- **`partInventories`**: `[PartInventory]` **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`pdf`**: `FileAttachment` Return pdf relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`pdfAssetId`**: `Int` Return pdf foreign key. --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`redlines`**: `[Redline]` **Arguments:** - `filters`: `RedlinesInputFilters` --- **`resultsHtmlLink`**: `String` --- **`resultsLink`**: `String` --- **`resultsS3Bucket`**: `String` --- **`resultsS3Key`**: `String` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int!` --- **`runStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`scheduledEnd`**: `DateTime` --- **`scheduledStart`**: `DateTime` --- **`sessions`**: `[Session]` --- **`settable`**: `String` --- **`slateContent`**: `SlateContent` --- **`sourceStep`**: `Step` --- **`standardStep`**: `Step` --- **`standardStepId`**: `Int` --- **`standardStepVersion`**: `Int` --- **`startTime`**: `DateTime` --- **`startedBy`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`startedById`**: `Int` --- **`status`**: `Statusenum!` --- **`steps`**: `[RunStep]` --- **`stepsCount`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepEventFilter` --- **`title`**: `String!` --- **`type`**: `runstepsteptypes` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstream`**: `[RunStepsEdge]` **Arguments:** - `filters`: `RunStepsEdgesInputFilters` --- **`upstreamStepIds`**: `[Int]` --- **`validNextStatuses`**: `[Statusenum]` # RunStepAttribute Source: https://docs.firstresonance.io/api-reference/types/RunStepAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # RunStepAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`runStepId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # RunStepAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunStepAttribute` --- **`oldValues`**: `RunStepAttribute` --- **`timestamp`**: `DateTime` # RunStepAttributedPart Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributedPart Auto-generated GQL type for RunStepAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # RunStepAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[RunStepAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[RunStepAttributedPartsInputFilters]` # RunStepAttributedUser Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributedUser Auto-generated GQL type for RunStepAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # RunStepAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[RunStepAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[RunStepAttributedUsersInputFilters]` # RunStepAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[RunStepAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[RunStepAttributesInputFilters]` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # RunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirement Run step build requirement. **Kind**: `object` ## Fields **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AssignedAndInstalledReferenceDesignatorsCount`**: `Float` The count of reference designators installed that are also assigned to this run step build requirement. --- **`_AssignedReferenceDesignatorsCount`**: `Int` The direct count of reference designators assigned to this run step from the procedure step part requirement assignments. --- **`_InstalledReferenceDesignatorsCount`**: `Float` The count of reference designators installed on the run step build requirement regardless of whether the reference designator is assigned. --- **`_ReferenceDesignatorAssignmentsCount`**: `Int` Optimized count of referenceDesignatorAssignments. --- **`_SubstitutesCount`**: `Int` Optimized count of substitutes. --- **`_TotalAssignedReferenceDesignatorsCount`**: `Float` The count of reference designators assigned to this run step build requirement multiplied by the parent assembly's quantity. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `[ABomInstallation]` --- **`acceptablePartIds`**: `[Int]` --- **`areReferenceDesignatorsFullyInstalled`**: `Boolean` --- **`assignedReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`divergedFromOrigin`**: `Boolean!` --- **`id`**: `String` Stringified unique row key (buildRequirementId and runStepId) for the graphql cache. --- **`installedQuantity`**: `Float` --- **`installedReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`isQuantityFullyInstalled`**: `Boolean` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`madeOnAssembly`**: `Boolean!` --- **`originStepPartRequirement`**: `StepPartRequirement` **Arguments:** - `filters`: `StepPartRequirementsInputFilters` --- **`originStepPartRequirementId`**: `ID` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`quantityPerParentPartInventory`**: `Float!` --- **`referenceDesignatorAssignments`**: `[RunReferenceDesignatorAssignment]` **Arguments:** - `filters`: `RunReferenceDesignatorAssignmentsInputFilters` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int` --- **`runPartInventoryQuantity`**: `Float!` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int!` --- **`substitutes`**: `[RunStepBuildRequirementSubstitute]` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RunStepBuildRequirementMaterialized Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementMaterialized A writable, per-run-step build requirement mapping. **Kind**: `object` ## Fields **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_AbomInstallationsCount`**: `Int` Optimized count of abomInstallations. --- **`_AssignedAndInstalledReferenceDesignatorsCount`**: `Float` The count of reference designators installed that are also assigned to this run step build requirement. --- **`_AssignedReferenceDesignatorsCount`**: `Int` The direct count of reference designators assigned to this run step from the procedure step part requirement assignments. --- **`_InstalledReferenceDesignatorsCount`**: `Float` The count of reference designators installed on the run step build requirement regardless of whether the reference designator is assigned. --- **`_ReferenceDesignatorAssignmentsCount`**: `Int` Optimized count of referenceDesignatorAssignments. --- **`_SubstitutesCount`**: `Int` Optimized count of substitutes. --- **`_TotalAssignedReferenceDesignatorsCount`**: `Float` The count of reference designators assigned to this run step build requirement multiplied by the parent assembly's quantity. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`abomInstallations`**: `ABomInstallation` **Arguments:** - `filters`: `ABomInstallationsInputFilters` --- **`areReferenceDesignatorsFullyInstalled`**: `Boolean` --- **`assignedReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`divergedFromOrigin`**: `Boolean!` --- **`id`**: `String` Stringified unique row key (buildRequirementId and runStepId) for the graphql cache. --- **`installedQuantity`**: `Float` --- **`installedReferenceDesignators`**: `[BuildRequirementReferenceDesignator]` **Arguments:** - `filters`: `BuildRequirementReferenceDesignatorsInputFilters` --- **`isQuantityFullyInstalled`**: `Boolean` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`madeOnAssembly`**: `Boolean!` --- **`originStepPartRequirement`**: `StepPartRequirement` **Arguments:** - `filters`: `StepPartRequirementsInputFilters` --- **`originStepPartRequirementId`**: `Int` --- **`prettyStr`**: `String` --- **`quantity`**: `Float!` --- **`quantityPerParentPartInventory`**: `Float!` --- **`referenceDesignatorAssignments`**: `[RunReferenceDesignatorAssignment]` **Arguments:** - `filters`: `RunReferenceDesignatorAssignmentsInputFilters` --- **`run`**: `Run` **Arguments:** - `filters`: `RunsInputFilters` --- **`runId`**: `Int!` --- **`runPartInventoryQuantity`**: `Float!` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int!` --- **`substitutes`**: `RunStepBuildRequirementSubstitute` **Arguments:** - `filters`: `RunStepBuildRequirementSubstitutesInputFilters` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RunStepBuildRequirementSortEnum Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementSortEnum **Kind**: `enum` ## Values **`ARE_REFERENCE_DESIGNATORS_FULLY_INSTALLED_ASC`** **`ARE_REFERENCE_DESIGNATORS_FULLY_INSTALLED_DESC`** **`BUILD_REQUIREMENT_ID_ASC`** **`BUILD_REQUIREMENT_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DIVERGED_FROM_ORIGIN_ASC`** **`DIVERGED_FROM_ORIGIN_DESC`** **`ID_ASC`** **`ID_DESC`** **`INSTALLED_QUANTITY_ASC`** **`INSTALLED_QUANTITY_DESC`** **`IS_QUANTITY_FULLY_INSTALLED_ASC`** **`IS_QUANTITY_FULLY_INSTALLED_DESC`** **`MADE_ON_ASSEMBLY_ASC`** **`MADE_ON_ASSEMBLY_DESC`** **`ORIGIN_STEP_PART_REQUIREMENT_ID_ASC`** **`ORIGIN_STEP_PART_REQUIREMENT_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`QUANTITY_PER_PARENT_PART_INVENTORY_ASC`** **`QUANTITY_PER_PARENT_PART_INVENTORY_DESC`** **`RUN_ID_ASC`** **`RUN_ID_DESC`** **`RUN_PART_INVENTORY_QUANTITY_ASC`** **`RUN_PART_INVENTORY_QUANTITY_DESC`** **`RUN_STEP_ID_ASC`** **`RUN_STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_DELETED_ASC`** **`_DELETED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RunStepBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementSubstitute A step-scoped substitute for a build requirement on one run step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`buildRequirement`**: `BuildRequirement` **Arguments:** - `filters`: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`runStepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepBuildRequirementSubstituteEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # RunStepBuildRequirementSubstituteEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementSubstituteEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partId`**: `IDFilter` --- **`runStepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # RunStepBuildRequirementSubstituteEvents Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementSubstituteEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunStepBuildRequirementSubstitute` --- **`oldValues`**: `RunStepBuildRequirementSubstitute` --- **`timestamp`**: `DateTime` # RunStepBuildRequirementSubstitutesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementSubstitutesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RunStepBuildRequirementSubstitutesInputFilters]` --- **`buildRequirementId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RunStepBuildRequirementSubstitutesInputFilters]` --- **`partId`**: `IDFilter` --- **`runStepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # RunStepBuildRequirementsConnection Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementsConnection **Kind**: `object` ## Fields **`edges`**: `[RunStepBuildRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RunStepBuildRequirementsEdge Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementsEdge A Relay edge containing a `RunStepBuildRequirements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RunStepBuildRequirement` The item at the end of the edge # RunStepBuildRequirementsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepBuildRequirementsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_deleted`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RunStepBuildRequirementsInputFilters]` --- **`areReferenceDesignatorsFullyInstalled`**: `BooleanFilter` --- **`assignedReferenceDesignators`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`buildRequirement`**: `BuildRequirementsInputFilters` --- **`buildRequirementId`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`divergedFromOrigin`**: `BooleanFilter` --- **`id`**: `StringFilter` --- **`installedQuantity`**: `FloatFilter` --- **`installedReferenceDesignators`**: `BuildRequirementReferenceDesignatorsInputFilters` --- **`isQuantityFullyInstalled`**: `BooleanFilter` --- **`madeOnAssembly`**: `BooleanFilter` --- **`or_`**: `[RunStepBuildRequirementsInputFilters]` --- **`originStepPartRequirement`**: `StepPartRequirementsInputFilters` --- **`originStepPartRequirementId`**: `IDFilter` --- **`quantity`**: `FloatFilter` --- **`quantityPerParentPartInventory`**: `FloatFilter` --- **`referenceDesignatorAssignments`**: `RunReferenceDesignatorAssignmentsInputFilters` --- **`run`**: `RunsInputFilters` --- **`runId`**: `IDFilter` --- **`runPartInventoryQuantity`**: `FloatFilter` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RunStepEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunStepEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`activeRedlineId`**: `IntFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`calculatedLeadTime`**: `IntFilter` --- **`completedById`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`displayPdf`**: `BooleanFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fullPosition`**: `StringFilter` --- **`hashCode`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`isOutsideProcess`**: `BooleanFilter` --- **`isStandardStep`**: `BooleanFilter` --- **`leadTime`**: `IntFilter` --- **`locationId`**: `IDFilter` --- **`originStepId`**: `IDFilter` --- **`pages`**: `IntFilter` --- **`parentId`**: `IDFilter` --- **`pdfAssetId`**: `IDFilter` --- **`position`**: `IntFilter` --- **`resultsS3Bucket`**: `StringFilter` --- **`resultsS3Key`**: `StringFilter` --- **`runId`**: `IDFilter` --- **`scheduledEnd`**: `DateTimeFilter` --- **`scheduledStart`**: `DateTimeFilter` --- **`standardStepId`**: `IDFilter` --- **`standardStepVersion`**: `IntFilter` --- **`startTime`**: `DateTimeFilter` --- **`startedById`**: `IDFilter` --- **`status`**: `StatusenumFilter` --- **`stepsCount`**: `IntFilter` --- **`title`**: `StringFilter` --- **`type`**: `runstepsteptypesFilter` --- **`updatedById`**: `IDFilter` # RunStepEvents Source: https://docs.firstresonance.io/api-reference/types/RunStepEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunStep` --- **`oldValues`**: `RunStep` --- **`timestamp`**: `DateTime` # RunStepField Source: https://docs.firstresonance.io/api-reference/types/RunStepField A StepField related to a particular Run. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_IonValueCount`**: `Int` --- **`_ValidationsCount`**: `Int` Optimized count of validations. --- **`_ValueCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[RunStepField]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`allowNotApplicable`**: `Boolean!` --- **`allowedIonType`**: `runstepfieldiontypeentitytypeenum` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`batchAdoptedSiblings`**: `[RunStepField]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[RunStepField]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`display`**: `String` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`helpText`**: `String` --- **`id`**: `Int!` --- **`ionValue`**: `IonType` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`notApplicable`**: `Boolean!` --- **`options`**: `[String]` --- **`originField`**: `StepField` **Arguments:** - `filters`: `FieldsInputFilters` --- **`originFieldId`**: `Int` --- **`part`**: `Part` Return part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` Return part foreign key relation. --- **`partInventory`**: `PartInventory` Return part inventory relationship. **Arguments:** - `filters`: `PartInventoriesInputFilters` --- **`partInventoryId`**: `Int` Return part inventory foreign key relation. --- **`partSubtype`**: `PartSubtype` Return part subtype relationship. **Arguments:** - `filters`: `PartSubtypesInputFilters` --- **`partSubtypeId`**: `Int` Return part subtype foreign key relation. --- **`peerReviewRequired`**: `Boolean!` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`required`**: `Boolean!` --- **`runStepId`**: `Int` --- **`settable`**: `Boolean` --- **`signoffRole`**: `Role` Get Role for signoff. Returns: relationship object **Arguments:** - `filters`: `RolesInputFilters` --- **`signoffRoleId`**: `Int` --- **`step`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepFieldEventFilter` --- **`type`**: `runstepfieldfieldtypes` --- **`unit`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id --- **`valid`**: `Boolean` --- **`validations`**: `[RunStepFieldValidation]` **Arguments:** - `filters`: `RunStepFieldValidationsInputFilters` --- **`value`**: `ScalarValue` # RunStepFieldEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowNotApplicable`**: `BooleanFilter` --- **`allowedIonType`**: `runstepfieldiontypeentitytypeenumFilter` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`display`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`helpText`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`notApplicable`**: `BooleanFilter` --- **`originFieldId`**: `IDFilter` --- **`partId`**: `IDFilter` --- **`partInventoryId`**: `IDFilter` --- **`partSubtypeId`**: `IDFilter` --- **`peerReviewRequired`**: `BooleanFilter` --- **`position`**: `IntFilter` --- **`required`**: `BooleanFilter` --- **`runStepId`**: `IDFilter` --- **`signoffRoleId`**: `IDFilter` --- **`type`**: `runstepfieldfieldtypesFilter` --- **`unit`**: `StringFilter` --- **`updatedById`**: `IDFilter` # RunStepFieldEvents Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunStepField` --- **`oldValues`**: `RunStepField` --- **`timestamp`**: `DateTime` # RunStepFieldInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldInputFilters Additional filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowNotApplicable`**: `BooleanFilter` --- **`allowedIonType`**: `runstepfieldiontypeentitytypeenumFilter` --- **`and_`**: `[RunStepFieldInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`batched`**: `BooleanFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`display`**: `StringFilter` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`helpText`**: `StringFilter` --- **`id`**: `IDFilter` --- **`ionValue`**: `IonTypeFilterInput` --- **`name`**: `StringFilter` --- **`notApplicable`**: `BooleanFilter` --- **`or_`**: `[RunStepFieldInputFilters]` --- **`originField`**: `FieldsInputFilters` --- **`originFieldId`**: `IDFilter` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`partSubtype`**: `PartSubtypesInputFilters` --- **`partSubtypeId`**: `IDFilter` --- **`peerReviewRequired`**: `BooleanFilter` --- **`position`**: `IntFilter` --- **`required`**: `BooleanFilter` --- **`runStepId`**: `IDFilter` --- **`settable`**: `BooleanFilter` --- **`signoffRole`**: `RolesInputFilters` --- **`signoffRoleId`**: `IDFilter` --- **`step`**: `RunStepsInputFilters` --- **`type`**: `runstepfieldfieldtypesFilter` --- **`unit`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`validations`**: `RunStepFieldValidationsInputFilters` --- **`value`**: `ScalarValueFilter` # RunStepFieldSortEnum Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldSortEnum **Kind**: `enum` ## Values **`ALLOWED_ION_TYPE_ASC`** **`ALLOWED_ION_TYPE_DESC`** **`ALLOW_NOT_APPLICABLE_ASC`** **`ALLOW_NOT_APPLICABLE_DESC`** **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DISPLAY_ASC`** **`DISPLAY_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FILE_ATTACHMENT_ID_ASC`** **`FILE_ATTACHMENT_ID_DESC`** **`HELP_TEXT_ASC`** **`HELP_TEXT_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`NOT_APPLICABLE_ASC`** **`NOT_APPLICABLE_DESC`** **`OPTIONS_ASC`** **`OPTIONS_DESC`** **`ORIGIN_FIELD_ID_ASC`** **`ORIGIN_FIELD_ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PART_INVENTORY_ID_ASC`** **`PART_INVENTORY_ID_DESC`** **`PART_SUBTYPE_ID_ASC`** **`PART_SUBTYPE_ID_DESC`** **`PEER_REVIEW_REQUIRED_ASC`** **`PEER_REVIEW_REQUIRED_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`REQUIRED_ASC`** **`REQUIRED_DESC`** **`SIGNOFF_ROLE_ID_ASC`** **`SIGNOFF_ROLE_ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UNIT_ASC`** **`UNIT_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_BOOLEAN_VALUE_ASC`** **`_BOOLEAN_VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_DATETIME_VALUE_ASC`** **`_DATETIME_VALUE_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_MULTISELECT_VALUES_ASC`** **`_MULTISELECT_VALUES_DESC`** **`_NUMBER_VALUE_ASC`** **`_NUMBER_VALUE_DESC`** **`_SELECT_VALUE_ASC`** **`_SELECT_VALUE_DESC`** **`_STRING_VALUE_ASC`** **`_STRING_VALUE_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidation run step field validation GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allBatchedSiblings`**: `[RunStepFieldValidation]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchAdoptedSiblings`**: `[RunStepFieldValidation]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batchSiblings`**: `[RunStepFieldValidation]` > Deprecated: Removed in July 2025. This field returns an empty list and will be removed in a future release. --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`function`**: `ValidationFunction` Return function related to validation object. **Arguments:** - `filters`: `ValidationFunctionsInputFilters` --- **`functionId`**: `Int!` Return foriegn key relation from validation to function. --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`result`**: `Validationresultenum!` --- **`runStepField`**: `RunStepField` **Arguments:** - `filters`: `RunStepFieldInputFilters` --- **`runStepFieldId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepFieldValidationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`validation`**: `StepFieldValidation` **Arguments:** - `filters`: `StepFieldValidationsInputFilters` --- **`validationId`**: `Int` --- **`value`**: `Float` # RunStepFieldValidationEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`functionId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`position`**: `IntFilter` --- **`result`**: `ValidationresultenumFilter` --- **`runStepFieldId`**: `IDFilter` --- **`updatedById`**: `IDFilter` --- **`validationId`**: `IDFilter` --- **`value`**: `FloatFilter` # RunStepFieldValidationEvents Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunStepFieldValidation` --- **`oldValues`**: `RunStepFieldValidation` --- **`timestamp`**: `DateTime` # RunStepFieldValidationSortEnum Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidationSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FUNCTION_ID_ASC`** **`FUNCTION_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`RESULT_ASC`** **`RESULT_DESC`** **`RUN_STEP_FIELD_ID_ASC`** **`RUN_STEP_FIELD_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALIDATION_ID_ASC`** **`VALIDATION_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RunStepFieldValidationsConnection Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidationsConnection **Kind**: `object` ## Fields **`edges`**: `[RunStepFieldValidationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RunStepFieldValidationsEdge Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidationsEdge A Relay edge containing a `RunStepFieldValidations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RunStepFieldValidation` The item at the end of the edge # RunStepFieldValidationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldValidationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RunStepFieldValidationsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`function`**: `ValidationFunctionsInputFilters` --- **`functionId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RunStepFieldValidationsInputFilters]` --- **`position`**: `IntFilter` --- **`result`**: `ValidationresultenumFilter` --- **`runStepField`**: `RunStepFieldInputFilters` --- **`runStepFieldId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`validation`**: `StepFieldValidationsInputFilters` --- **`validationId`**: `IDFilter` --- **`value`**: `FloatFilter` # RunStepFieldsConnection Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldsConnection **Kind**: `object` ## Fields **`edges`**: `[RunStepFieldsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RunStepFieldsEdge Source: https://docs.firstresonance.io/api-reference/types/RunStepFieldsEdge A Relay edge containing a `RunStepFields` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RunStepField` The item at the end of the edge # RunStepSettings Source: https://docs.firstresonance.io/api-reference/types/RunStepSettings Organization settings related to run steps. **Kind**: `object` ## Fields **`allowRunStepsToCompleteWithoutRequiredInstalls`**: `Boolean` --- **`attributes`**: `[AttributeSettings]` --- **`canceledStepDependenciesShouldNotBlockDownstreamSteps`**: `Boolean` # RunStepSettingsInput Source: https://docs.firstresonance.io/api-reference/types/RunStepSettingsInput Input settings related to run steps. **Kind**: `input` ## Fields **`allowRunStepsToCompleteWithoutRequiredInstalls`**: `Boolean` --- **`canceledStepDependenciesShouldNotBlockDownstreamSteps`**: `Boolean` # RunStepSortEnum Source: https://docs.firstresonance.io/api-reference/types/RunStepSortEnum **Kind**: `enum` ## Values **`ACTIVE_REDLINE_ID_ASC`** **`ACTIVE_REDLINE_ID_DESC`** **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`BASE_POSITION_ASC`** **`BASE_POSITION_DESC`** **`BATCHED_SIBLING_IDS_ASC`** **`BATCHED_SIBLING_IDS_DESC`** **`CALCULATED_LEAD_TIME_ASC`** **`CALCULATED_LEAD_TIME_DESC`** **`COMPLETED_BY_ID_ASC`** **`COMPLETED_BY_ID_DESC`** **`CONTENT_ASC`** **`CONTENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DISPLAY_PDF_ASC`** **`DISPLAY_PDF_DESC`** **`END_TIME_ASC`** **`END_TIME_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FULL_POSITION_ASC`** **`FULL_POSITION_DESC`** **`HASH_CODE_ASC`** **`HASH_CODE_DESC`** **`ID_ASC`** **`ID_DESC`** **`IS_OUTSIDE_PROCESS_ASC`** **`IS_OUTSIDE_PROCESS_DESC`** **`IS_STANDARD_STEP_ASC`** **`IS_STANDARD_STEP_DESC`** **`LAST_REDLINE_ID_ASC`** **`LAST_REDLINE_ID_DESC`** **`LEAD_TIME_ASC`** **`LEAD_TIME_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`ORIGIN_STEP_ID_ASC`** **`ORIGIN_STEP_ID_DESC`** **`PAGES_ASC`** **`PAGES_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PDF_ASSET_ID_ASC`** **`PDF_ASSET_ID_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`RESULTS_S3_BUCKET_ASC`** **`RESULTS_S3_BUCKET_DESC`** **`RESULTS_S3_KEY_ASC`** **`RESULTS_S3_KEY_DESC`** **`RUN_ID_ASC`** **`RUN_ID_DESC`** **`SCHEDULED_END_ASC`** **`SCHEDULED_END_DESC`** **`SCHEDULED_START_ASC`** **`SCHEDULED_START_DESC`** **`STANDARD_STEP_ID_ASC`** **`STANDARD_STEP_ID_DESC`** **`STANDARD_STEP_VERSION_ASC`** **`STANDARD_STEP_VERSION_DESC`** **`STARTED_BY_ID_ASC`** **`STARTED_BY_ID_DESC`** **`START_TIME_ASC`** **`START_TIME_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEPS_COUNT_ASC`** **`STEPS_COUNT_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # RunStepsEdge Source: https://docs.firstresonance.io/api-reference/types/RunStepsEdge A RunStep's relationship to another RunStep. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`batchSiblings`**: `[RunStepsEdge]` --- **`batched`**: `Boolean` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`step`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `RunStepsEdgeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstreamStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`upstreamStepId`**: `Int!` # RunStepsEdgeEventFilter Source: https://docs.firstresonance.io/api-reference/types/RunStepsEdgeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` --- **`upstreamStepId`**: `IDFilter` # RunStepsEdgeEvents Source: https://docs.firstresonance.io/api-reference/types/RunStepsEdgeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `RunStepsEdge` --- **`oldValues`**: `RunStepsEdge` --- **`timestamp`**: `DateTime` # RunStepsEdgesInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepsEdgesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[RunStepsEdgesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[RunStepsEdgesInputFilters]` --- **`step`**: `RunStepsInputFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`upstreamStep`**: `RunStepsInputFilters` --- **`upstreamStepId`**: `IDFilter` # RunStepsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunStepsInputFilters Filters related to Run Steps. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`abomInstallations`**: `ABomInstallationsInputFilters` --- **`activeRedlineId`**: `IntFilter` --- **`allChildren`**: `RunStepsInputFilters` --- **`allParents`**: `RunStepsInputFilters` --- **`and_`**: `[RunStepsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`attributedParts`**: `RunStepAttributedPartsInputFilters` --- **`attributedUsers`**: `RunStepAttributedUsersInputFilters` --- **`attributes`**: `RunStepAttributesInputFilters` --- **`availableToWork`**: `BooleanFilter` --- **`batched`**: `BooleanFilter` --- **`calculatedLeadTime`**: `IntFilter` --- **`completedBy`**: `UserInputFilters` --- **`completedById`**: `IDFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`datagridColumns`**: `DatagridColumnsInputFilters` --- **`datagridRows`**: `DatagridRowsInputFilters` --- **`displayPdf`**: `BooleanFilter` --- **`downstream`**: `RunStepsEdgesInputFilters` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`fields`**: `RunStepFieldInputFilters` --- **`fileAttachments`**: `FileAttachmentsInputFilters` --- **`fullPosition`**: `StringFilter` --- **`hashCode`**: `StringFilter` --- **`id`**: `IDFilter` --- **`isChildStandardStep`**: `BooleanFilter` --- **`isLatched`**: `BooleanFilter` --- **`isOutsideProcess`**: `BooleanFilter` --- **`isStandardStep`**: `BooleanFilter` --- **`issues`**: `IssueInputFilters` --- **`leadTime`**: `IntFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`mustCloseByLinkedIssues`**: `IssueInputFilters` --- **`or_`**: `[RunStepsInputFilters]` --- **`originStep`**: `StepsFilters` --- **`originStepId`**: `IDFilter` --- **`pages`**: `IntFilter` --- **`parentId`**: `IDFilter` --- **`partInventories`**: `PartInventoriesInputFilters` --- **`pdf`**: `FileAttachmentsInputFilters` --- **`pdfAssetId`**: `IDFilter` --- **`position`**: `IntFilter` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`redlines`**: `RedlinesInputFilters` --- **`resultsS3Bucket`**: `StringFilter` --- **`resultsS3Key`**: `StringFilter` --- **`run`**: `RunsInputFilters` --- **`runId`**: `IDFilter` --- **`runStepBuildRequirements`**: `RunStepBuildRequirementsInputFilters` --- **`scheduledEnd`**: `DateTimeFilter` --- **`scheduledStart`**: `DateTimeFilter` --- **`sessions`**: `SessionsInputFilters` --- **`standardStepId`**: `IDFilter` --- **`standardStepVersion`**: `IntFilter` --- **`startTime`**: `DateTimeFilter` --- **`startedBy`**: `UserInputFilters` --- **`startedById`**: `IDFilter` --- **`status`**: `StatusenumFilter` --- **`stepsCount`**: `IntFilter` --- **`title`**: `StringFilter` --- **`type`**: `runstepsteptypesFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`upstream`**: `RunStepsEdgesInputFilters` # RunsConnection Source: https://docs.firstresonance.io/api-reference/types/RunsConnection **Kind**: `object` ## Fields **`edges`**: `[RunsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RunsEdge Source: https://docs.firstresonance.io/api-reference/types/RunsEdge A Relay edge containing a `Runs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Run` The item at the end of the edge # RunsInputFilters Source: https://docs.firstresonance.io/api-reference/types/RunsInputFilters Filters related to Runs. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_export_controlled`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`abomCompletionJustification`**: `StringFilter` --- **`abomCompletionJustificationAt`**: `DateTimeFilter` --- **`abomCompletionJustificationBy`**: `IDFilter` --- **`abomCompletionJustificationUser`**: `UserInputFilters` --- **`abomJustificationSubmitted`**: `BooleanFilter` --- **`and_`**: `[RunsInputFilters]` --- **`archived`**: `BooleanFilter` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`attributedParts`**: `RunAttributedPartsInputFilters` --- **`attributedUsers`**: `RunAttributedUsersInputFilters` --- **`attributes`**: `RunAttributesInputFilters` --- **`batched`**: `BooleanFilter` --- **`calculatedLeadTime`**: `IntFilter` --- **`completedQuantity`**: `FloatFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`dueDate`**: `DateTimeFilter` --- **`endTime`**: `DateTimeFilter` --- **`entityId`**: `IDFilter` --- **`exportControlled`**: `BooleanFilter` --- **`furtherActions`**: `FurtherActionsInputFilters` --- **`id`**: `IDFilter` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IDFilter` --- **`isComplexAssembly`**: `BooleanFilter` --- **`isOpen`**: `BooleanFilter` --- **`issues`**: `IssueInputFilters` --- **`jiraIssueKey`**: `StringFilter` --- **`labels`**: `LabelsInputFilters` --- **`locationId`**: `IDFilter` --- **`locations`**: `LocationsInputFilters` --- **`or_`**: `[RunsInputFilters]` --- **`originPartInventories`**: `PartInventoriesInputFilters` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`partInventory`**: `PartInventoriesInputFilters` --- **`partInventoryId`**: `IDFilter` --- **`partKits`**: `PartKitsInputFilters` --- **`partNumber`**: `StringFilter` --- **`percentComplete`**: `IntFilter` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureId`**: `IDFilter` --- **`quantity`**: `IntFilter` --- **`redlines`**: `RedlinesInputFilters` --- **`resultsLink`**: `StringFilter` --- **`runBatch`**: `RunBatchesInputFilters` --- **`runBatchId`**: `IDFilter` --- **`scheduledEnd`**: `DateTimeFilter` --- **`scheduledStart`**: `DateTimeFilter` --- **`sessions`**: `SessionsInputFilters` --- **`startTime`**: `DateTimeFilter` --- **`status`**: `RunStatusFilter` --- **`steps`**: `RunStepsInputFilters` --- **`title`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # RunsStepsConnection Source: https://docs.firstresonance.io/api-reference/types/RunsStepsConnection **Kind**: `object` ## Fields **`edges`**: `[RunsStepsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # RunsStepsEdge Source: https://docs.firstresonance.io/api-reference/types/RunsStepsEdge A Relay edge containing a `RunsSteps` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `RunStep` The item at the end of the edge # SSOConnectionStatus Source: https://docs.firstresonance.io/api-reference/types/SSOConnectionStatus Current SSO connection status for an organization. **Kind**: `object` ## Fields **`configured`**: `Boolean` --- **`connectionId`**: `String` --- **`providerName`**: `String` --- **`providerType`**: `String` # SSOSigningRotation Source: https://docs.firstresonance.io/api-reference/types/SSOSigningRotation Connection state observed after the signing credentials were rotated. **Kind**: `object` ## Fields **`certFingerprint`**: `String` --- **`connectionName`**: `String` # SSOTicketResult Source: https://docs.firstresonance.io/api-reference/types/SSOTicketResult Result of generating an SSO setup ticket. **Kind**: `object` ## Fields **`ticketUrl`**: `String` # SaveReceipt Source: https://docs.firstresonance.io/api-reference/types/SaveReceipt Mutation to handle all of the logic of saving a receipt including creating/updating receipt items and inventory. **Kind**: `object` ## Fields **`consumedPartInventoryIds`**: `[Int]` --- **`mergedPartInventories`**: `[PartInventory]` --- **`receipt`**: `Receipt` # SaveReceiptInput Source: https://docs.firstresonance.io/api-reference/types/SaveReceiptInput Input object for saving a receipt. **Kind**: `input` ## Fields **`attributes`**: `[ExtensibleAttributeInput]` --- **`etag`**: `String` --- **`receiptId`**: `ID` --- **`receiptItems`**: `[CreateReceiptItemOnReceiptInput]` # ScalarValue Source: https://docs.firstresonance.io/api-reference/types/ScalarValue Multi-type scalar value. **Kind**: `scalar` # ScalarValueFilter Source: https://docs.firstresonance.io/api-reference/types/ScalarValueFilter **Kind**: `input` ## Fields **`eq`**: `ScalarValue` --- **`fuzzyMatch`**: `ScalarValueFuzzyMatchFilter` --- **`gt`**: `ScalarValue` --- **`gte`**: `ScalarValue` --- **`ilike`**: `ScalarValue` --- **`in`**: `[ScalarValue]` --- **`isnull`**: `Boolean` --- **`like`**: `ScalarValue` --- **`lt`**: `ScalarValue` --- **`lte`**: `ScalarValue` --- **`neq`**: `ScalarValue` --- **`notilike`**: `ScalarValue` --- **`notlike`**: `ScalarValue` # ScalarValueFuzzyMatchFilter Source: https://docs.firstresonance.io/api-reference/types/ScalarValueFuzzyMatchFilter **Kind**: `input` ## Fields **`similarity`**: `Float` = 0.5 ('Float value between 0 and 1, with 1 being a direct string ', 'match. The higher the similarity value the closer two string ', 'must be in order to be considered a match.') --- **`value`**: `ScalarValue` # ScanBarcode Source: https://docs.firstresonance.io/api-reference/types/ScanBarcode List of entities matching barcode. **Kind**: `object` ## Fields **`entities`**: `[Entity]` # ScanContext Source: https://docs.firstresonance.io/api-reference/types/ScanContext Context for scanning a barcode. **Kind**: `input` ## Fields **`runStepId`**: `Int` # SearchToolsInput Source: https://docs.firstresonance.io/api-reference/types/SearchToolsInput **Kind**: `input` ## Fields **`maintenanceStatuses`**: `[MaintenanceStatus]!` (required) --- **`searchTerm`**: `String!` (required) # SerialGeneratorType Source: https://docs.firstresonance.io/api-reference/types/SerialGeneratorType Enum for types of serial number generator. **Kind**: `enum` ## Values **`GLOBAL_UNIQUE_SERIAL_NUMBER`** **`REVISION`** # Session Source: https://docs.firstresonance.io/api-reference/types/Session Session represents the times checked in and checked out for work on a runstep. **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_etag`**: `String` --- **`checkIn`**: `DateTime!` --- **`checkOut`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`duration`**: `Float` --- **`eventType`**: `Eventtypeenum!` --- **`id`**: `Int!` --- **`isValidGrouping`**: `Boolean` --- **`prettyStr`**: `String` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SessionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id # SessionEvent Source: https://docs.firstresonance.io/api-reference/types/SessionEvent SessionEvent represents the times checked in and checked out for work on a runstep. **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`checkIn`**: `DateTime!` --- **`checkOut`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`duration`**: `Float` --- **`eventType`**: `Eventtypeenum!` --- **`id`**: `ID!` --- **`isValidGrouping`**: `Boolean` --- **`prettyStr`**: `String` --- **`runStep`**: `RunStep` **Arguments:** - `filters`: `RunStepsInputFilters` --- **`runStepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id that updated this object. Returns: int of user_id # SessionEventFilter Source: https://docs.firstresonance.io/api-reference/types/SessionEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`checkIn`**: `DateTimeFilter` --- **`checkOut`**: `DateTimeFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`runStepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # SessionEventInput Source: https://docs.firstresonance.io/api-reference/types/SessionEventInput Common input for all check in and check out events. **Kind**: `input` ## Fields **`runStepId`**: `ID!` (required) --- **`userId`**: `ID` # SessionEvents Source: https://docs.firstresonance.io/api-reference/types/SessionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Session` --- **`oldValues`**: `Session` --- **`timestamp`**: `DateTime` # SessionSortEnum Source: https://docs.firstresonance.io/api-reference/types/SessionSortEnum **Kind**: `enum` ## Values **`CHECK_IN_ASC`** **`CHECK_IN_DESC`** **`CHECK_OUT_ASC`** **`CHECK_OUT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # SessionsConnection Source: https://docs.firstresonance.io/api-reference/types/SessionsConnection **Kind**: `object` ## Fields **`edges`**: `[SessionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # SessionsEdge Source: https://docs.firstresonance.io/api-reference/types/SessionsEdge A Relay edge containing a `Sessions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Session` The item at the end of the edge # SessionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/SessionsInputFilters Declare input filters for sessions. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[SessionsInputFilters]` --- **`checkIn`**: `DateTimeFilter` --- **`checkOut`**: `DateTimeFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`duration`**: `FloatFilter` --- **`eventType`**: `EventtypeenumFilter` --- **`id`**: `IDFilter` --- **`isValidGrouping`**: `BooleanFilter` --- **`or_`**: `[SessionsInputFilters]` --- **`runStep`**: `RunStepsInputFilters` --- **`runStepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # SetDatagridValue Source: https://docs.firstresonance.io/api-reference/types/SetDatagridValue Set a datagrid value. **Kind**: `object` ## Fields **`datagridValue`**: `DatagridValue` # SetDatagridValueInput Source: https://docs.firstresonance.io/api-reference/types/SetDatagridValueInput Input to set datagrid value for a specific column and row. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`columnId`**: `Int!` (required) --- **`etag`**: `String` --- **`notApplicable`**: `Boolean` --- **`rowId`**: `Int!` (required) --- **`value`**: `ScalarValue` # SimplePolicySettings Source: https://docs.firstresonance.io/api-reference/types/SimplePolicySettings Settings for simple policies (enabled only). **Kind**: `object` ## Fields **`enabled`**: `Boolean` # SimplePolicySettingsInput Source: https://docs.firstresonance.io/api-reference/types/SimplePolicySettingsInput Input for simple policies (enabled only). **Kind**: `input` ## Fields **`enabled`**: `Boolean` # SlateContent Source: https://docs.firstresonance.io/api-reference/types/SlateContent Passthrough JSON type. **Kind**: `scalar` # SlateContentFilter Source: https://docs.firstresonance.io/api-reference/types/SlateContentFilter **Kind**: `input` ## Fields **`eq`**: `SlateContent` --- **`gt`**: `SlateContent` --- **`gte`**: `SlateContent` --- **`ilike`**: `SlateContent` --- **`in`**: `[SlateContent]` --- **`isnull`**: `Boolean` --- **`like`**: `SlateContent` --- **`lt`**: `SlateContent` --- **`lte`**: `SlateContent` --- **`neq`**: `SlateContent` --- **`notilike`**: `SlateContent` --- **`notlike`**: `SlateContent` # SlateContentNullFilter Source: https://docs.firstresonance.io/api-reference/types/SlateContentNullFilter **Kind**: `input` ## Fields **`isnull`**: `Boolean` # SnapshotExportJob Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJob Snapshot Export Job GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`destination`**: `SnapshotExportJobDestination!` --- **`downloadUrls`**: `[SnapshotExportJobFile]` --- **`errors`**: `JSONString!` --- **`exportDuration`**: `Int` --- **`exportFiles`**: `JSONString!` --- **`exportOptions`**: `JSONString!` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`fileSizeBytes`**: `Float` --- **`filename`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`status`**: `SnapshotExportJobStatus!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SnapshotExportJobEventFilter` --- **`totalSizeBytes`**: `String` --- **`type`**: `Snapshotexportjobtypeenum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # SnapshotExportJobDestination Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobDestination Enum of snapshot export job destinations. **Kind**: `enum` ## Values **`CUSTOMER_S3`** **`FR_S3`** # SnapshotExportJobDestinationFilter Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobDestinationFilter **Kind**: `input` ## Fields **`eq`**: `SnapshotExportJobDestination` --- **`gt`**: `SnapshotExportJobDestination` --- **`gte`**: `SnapshotExportJobDestination` --- **`ilike`**: `SnapshotExportJobDestination` --- **`in`**: `[SnapshotExportJobDestination]` --- **`isnull`**: `Boolean` --- **`like`**: `SnapshotExportJobDestination` --- **`lt`**: `SnapshotExportJobDestination` --- **`lte`**: `SnapshotExportJobDestination` --- **`neq`**: `SnapshotExportJobDestination` --- **`notilike`**: `SnapshotExportJobDestination` --- **`notlike`**: `SnapshotExportJobDestination` # SnapshotExportJobEventFilter Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`destination`**: `SnapshotExportJobDestinationFilter` --- **`eventType`**: `EventTypeFilter` --- **`filename`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`status`**: `SnapshotExportJobStatusFilter` --- **`type`**: `SnapshotexportjobtypeenumFilter` --- **`updatedById`**: `IDFilter` # SnapshotExportJobEvents Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `SnapshotExportJob` --- **`oldValues`**: `SnapshotExportJob` --- **`timestamp`**: `DateTime` # SnapshotExportJobFile Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobFile Individual file within a snapshot export job. **Kind**: `object` ## Fields **`fileSizeBytes`**: `String` --- **`filename`**: `String!` --- **`partNumber`**: `Int` --- **`url`**: `String!` # SnapshotExportJobSortEnum Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESTINATION_ASC`** **`DESTINATION_DESC`** **`FILENAME_ASC`** **`FILENAME_DESC`** **`ID_ASC`** **`ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # SnapshotExportJobStatus Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobStatus Enum of snapshot export job statuses. **Kind**: `enum` ## Values **`COMPLETED`** **`FAILED`** **`IN_PROGRESS`** **`PENDING`** # SnapshotExportJobStatusFilter Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobStatusFilter **Kind**: `input` ## Fields **`eq`**: `SnapshotExportJobStatus` --- **`gt`**: `SnapshotExportJobStatus` --- **`gte`**: `SnapshotExportJobStatus` --- **`ilike`**: `SnapshotExportJobStatus` --- **`in`**: `[SnapshotExportJobStatus]` --- **`isnull`**: `Boolean` --- **`like`**: `SnapshotExportJobStatus` --- **`lt`**: `SnapshotExportJobStatus` --- **`lte`**: `SnapshotExportJobStatus` --- **`neq`**: `SnapshotExportJobStatus` --- **`notilike`**: `SnapshotExportJobStatus` --- **`notlike`**: `SnapshotExportJobStatus` # SnapshotExportJobsConnection Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobsConnection **Kind**: `object` ## Fields **`edges`**: `[SnapshotExportJobsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # SnapshotExportJobsEdge Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobsEdge A Relay edge containing a `SnapshotExportJobs` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `SnapshotExportJob` The item at the end of the edge # SnapshotExportJobsInputFilters Source: https://docs.firstresonance.io/api-reference/types/SnapshotExportJobsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[SnapshotExportJobsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`destination`**: `SnapshotExportJobDestinationFilter` --- **`filename`**: `StringFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[SnapshotExportJobsInputFilters]` --- **`status`**: `SnapshotExportJobStatusFilter` --- **`type`**: `SnapshotexportjobtypeenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Snapshotexportjobtypeenum Source: https://docs.firstresonance.io/api-reference/types/Snapshotexportjobtypeenum **Kind**: `enum` ## Values **`ATTACHMENTS`** **`TABLES`** # SnapshotexportjobtypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/SnapshotexportjobtypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Snapshotexportjobtypeenum` --- **`gt`**: `Snapshotexportjobtypeenum` --- **`gte`**: `Snapshotexportjobtypeenum` --- **`ilike`**: `Snapshotexportjobtypeenum` --- **`in`**: `[Snapshotexportjobtypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Snapshotexportjobtypeenum` --- **`lt`**: `Snapshotexportjobtypeenum` --- **`lte`**: `Snapshotexportjobtypeenum` --- **`neq`**: `Snapshotexportjobtypeenum` --- **`notilike`**: `Snapshotexportjobtypeenum` --- **`notlike`**: `Snapshotexportjobtypeenum` # Sourcingstrategyenum Source: https://docs.firstresonance.io/api-reference/types/Sourcingstrategyenum **Kind**: `enum` ## Values **`BUY`** **`DUAL_SOURCE`** **`MAKE`** # SourcingstrategyenumFilter Source: https://docs.firstresonance.io/api-reference/types/SourcingstrategyenumFilter **Kind**: `input` ## Fields **`eq`**: `Sourcingstrategyenum` --- **`gt`**: `Sourcingstrategyenum` --- **`gte`**: `Sourcingstrategyenum` --- **`ilike`**: `Sourcingstrategyenum` --- **`in`**: `[Sourcingstrategyenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Sourcingstrategyenum` --- **`lt`**: `Sourcingstrategyenum` --- **`lte`**: `Sourcingstrategyenum` --- **`neq`**: `Sourcingstrategyenum` --- **`notilike`**: `Sourcingstrategyenum` --- **`notlike`**: `Sourcingstrategyenum` # SplitManyPartInventory Source: https://docs.firstresonance.io/api-reference/types/SplitManyPartInventory Split inventory in many inventories with specified quantities and return all. **Kind**: `object` ## Fields **`partInventories`**: `[PartInventory]` # SplitManyPartInventoryEachInput Source: https://docs.firstresonance.io/api-reference/types/SplitManyPartInventoryEachInput Input for each inventory output of a split many operation. **Kind**: `input` ## Fields **`quantity`**: `Float!` (required) # SplitManyPartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/SplitManyPartInventoryInput Input to break off many inventory from a lot. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`partInventories`**: `[SplitManyPartInventoryEachInput]` --- **`sort`**: `Boolean` # SplitPartInventory Source: https://docs.firstresonance.io/api-reference/types/SplitPartInventory Split inventory in two and return new inventory with specified quantity. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` # SplitPartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/SplitPartInventoryInput Input the ID and etag of the inventory to be split and quantity to split. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`quantity`**: `Float!` (required) # SplitUnfulfilledPartKit Source: https://docs.firstresonance.io/api-reference/types/SplitUnfulfilledPartKit Split unfulfilled part kit items into new part kit. **Kind**: `object` ## Fields **`partKit`**: `PartKit` # SplitUnfulfilledPartKitInput Source: https://docs.firstresonance.io/api-reference/types/SplitUnfulfilledPartKitInput Inputs needed to split unfulfilled items into new kit. **Kind**: `input` ## Fields **`etag`**: `String!` (required) Etag of the part kit. --- **`partKitId`**: `ID!` (required) # Standardstepstatusenum Source: https://docs.firstresonance.io/api-reference/types/Standardstepstatusenum **Kind**: `enum` ## Values **`ARCHIVED`** **`DRAFT`** **`IN_REVIEW`** **`RELEASED`** # StandardstepstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/StandardstepstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Standardstepstatusenum` --- **`gt`**: `Standardstepstatusenum` --- **`gte`**: `Standardstepstatusenum` --- **`ilike`**: `Standardstepstatusenum` --- **`in`**: `[Standardstepstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Standardstepstatusenum` --- **`lt`**: `Standardstepstatusenum` --- **`lte`**: `Standardstepstatusenum` --- **`neq`**: `Standardstepstatusenum` --- **`notilike`**: `Standardstepstatusenum` --- **`notlike`**: `Standardstepstatusenum` # Statusenum Source: https://docs.firstresonance.io/api-reference/types/Statusenum **Kind**: `enum` ## Values **`CANCELED`** **`COMPLETE`** **`DAG_MODIFIABLE`** **`FAILED`** **`HOLD`** **`IN_PROGRESS`** **`REDLINE`** **`TODO`** # StatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/StatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Statusenum` --- **`gt`**: `Statusenum` --- **`gte`**: `Statusenum` --- **`ilike`**: `Statusenum` --- **`in`**: `[Statusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Statusenum` --- **`lt`**: `Statusenum` --- **`lte`**: `Statusenum` --- **`neq`**: `Statusenum` --- **`notilike`**: `Statusenum` --- **`notlike`**: `Statusenum` # Step Source: https://docs.firstresonance.io/api-reference/types/Step Steps are processes to be done individually in Procedures. **Kind**: `object` ## Fields **`Attributes`**: `[StepAttribute]` **Arguments:** - `filters`: `StepAttributesInputFilters` --- **`Parent`**: `String` --- **`_AllChildrenCount`**: `Int` --- **`_AllParentsCount`**: `Int` --- **`_AncestorStepsCount`**: `Int` Optimized count of ancestorSteps. --- **`_ApprovalRequestsCount`**: `Int` Optimized count of approvalRequests. --- **`_ApprovalsCount`**: `Int` Optimized count of approvals. --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_DatagridColumnsCount`**: `Int` Optimized count of datagridColumns. --- **`_DatagridRowsCount`**: `Int` Optimized count of datagridRows. --- **`_DerivedStepsCount`**: `Int` Optimized count of derivedSteps. --- **`_DescendantStepsCount`**: `Int` Optimized count of descendantSteps. --- **`_DownstreamCount`**: `Int` Optimized count of downstream. --- **`_FieldsCount`**: `Int` Optimized count of fields. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_ProcedureApprovalsCount`**: `Int` Optimized count of procedureApprovals. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReviewsCount`**: `Int` Optimized count of reviews. --- **`_RoleBasedApprovalRequestsCount`**: `Int` Optimized count of roleBasedApprovalRequests. --- **`_RoleBasedApprovalsCount`**: `Int` Optimized count of roleBasedApprovals. --- **`_StepPartRequirementsCount`**: `Int` Optimized count of stepPartRequirements. --- **`_StepsCount`**: `Int` Optimized count of steps. --- **`_UpstreamCount`**: `Int` Optimized count of upstream. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allChildren`**: `[Step]` --- **`allParents`**: `[Step]` --- **`ancestorSteps`**: `[Step]` --- **`approvalRequests`**: `[StepApprovalRequest]` **Arguments:** - `filters`: `StepApprovalRequestsInputFilters` --- **`approvals`**: `[StepApproval]` **Arguments:** - `filters`: `StepApprovalsInputFilters` --- **`approved`**: `Boolean` --- **`assets`**: `[FileAttachment]` --- **`attributedParts`**: `[StepAttributedPart]` **Arguments:** - `filters`: `StepAttributedPartsInputFilters` --- **`attributedUsers`**: `[StepAttributedUser]` **Arguments:** - `filters`: `StepAttributedUsersInputFilters` --- **`attributes`**: `[StepAttribute]` --- **`content`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`datagrid`**: `DataGrid` > Deprecated: Deprecated --- **`datagridColumns`**: `DatagridColumnsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridColumnsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridColumnSortEnum]` --- **`datagridRows`**: `DatagridRowsConnection` **Arguments:** - `after`: `String` - `before`: `String` - `filters`: `DatagridRowsInputFilters` - `first`: `Int` - `last`: `Int` - `sort`: `[DatagridRowSortEnum]` --- **`derivedSteps`**: `[Step]` --- **`descendantSteps`**: `[Step]` --- **`displayPdf`**: `Boolean!` --- **`downstream`**: `[StepsEdge]` **Arguments:** - `filters`: `StepsEdgesInputFilters` --- **`downstreamStepIds`**: `[Int]` --- **`editable`**: `Boolean` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`executionEvidence`**: `StepExecutionEvidence` **Arguments:** - `feedbackLimit`: `Int` - `notableLimit`: `Int` - `recentLimit`: `Int` --- **`familyId`**: `Int!` Get column with related family id. This value serves as a "group id" for different versions of the "same" model object. For example, all versions of a standard step will have the same family_id. If a step is not a standard step, this will just equal the value of the step's id. Returns: Column instance --- **`fieldCount`**: `Int` --- **`fields`**: `[StepField]` **Arguments:** - `filters`: `FieldsInputFilters` --- **`fullPosition`**: `String` --- **`id`**: `Int!` --- **`intentOption`**: `IntentOption` Define intent option relationship. **Arguments:** - `filters`: `IntentOptionsInputFilters` --- **`intentOptionId`**: `Int` Define intent option id foreign key. --- **`isChildStandardStep`**: `Boolean` --- **`isDerivedStep`**: `Boolean` --- **`isLatestReleasedVersion`**: `Boolean` --- **`isLatestVersion`**: `Boolean` --- **`isOutsideProcess`**: `Boolean!` --- **`isRoleBased`**: `Boolean!` --- **`isStandardStep`**: `Boolean` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`leadTime`**: `Int` --- **`location`**: `Location` Return location relationship. **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` Return location foreign key. --- **`locationSubtype`**: `LocationSubtype` **Arguments:** - `filters`: `LocationSubtypesInputFilters` --- **`locationSubtypeId`**: `Int` --- **`originStep`**: `Step` --- **`originStepId`**: `Int` Return step id from which a copied step originated. --- **`pages`**: `[Int]` --- **`parent`**: `Step` --- **`parentId`**: `Int` Return self referential parent foreign key. --- **`parentIds`**: `[Int]` --- **`pdf`**: `FileAttachment` Return pdf relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`pdfAssetId`**: `Int` Return pdf foreign key. --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`procedure`**: `Procedure` **Arguments:** - `filters`: `ProceduresInputFilters` --- **`procedureApprovals`**: `[ProcedureApproval]` **Arguments:** - `filters`: `ProcedureApprovalsInputFilters` --- **`procedureId`**: `Int` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`reviews`**: `[Review]` **Arguments:** - `filters`: `ReviewsInputFilters` --- **`roleBasedApprovalRequests`**: `[StepRoleBasedApprovalRequest]` **Arguments:** - `filters`: `StepRoleBasedApprovalRequestsInputFilters` --- **`roleBasedApprovals`**: `[StepRoleBasedApproval]` **Arguments:** - `filters`: `StepRoleBasedApprovalsInputFilters` --- **`slateContent`**: `SlateContent` --- **`sourceStep`**: `Step` --- **`standardStep`**: `Step` --- **`standardStepFamilyId`**: `Int` --- **`standardStepId`**: `Int` --- **`standardStepProcedureCount`**: `Int` --- **`standardStepProcedures`**: `[Procedure]` --- **`standardStepRunCount`**: `Int` --- **`standardStepRuns`**: `[Run]` --- **`standardStepStatus`**: `Standardstepstatusenum` --- **`stepPartRequirements`**: `[StepPartRequirement]` --- **`steps`**: `[Step]` --- **`stepsCount`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepEventFilter` --- **`title`**: `String!` --- **`type`**: `Steptypes!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstream`**: `[StepsEdge]` **Arguments:** - `filters`: `StepsEdgesInputFilters` --- **`upstreamStepIds`**: `[Int]` --- **`version`**: `Int!` # StepApproval Source: https://docs.firstresonance.io/api-reference/types/StepApproval GraphQL model for an approval request related to a step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `StepApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[StepApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # StepApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/StepApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepApproval` --- **`oldValues`**: `StepApproval` --- **`timestamp`**: `DateTime` # StepApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequest GraphQL model for an approval request related to a step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # StepApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepApprovalRequest` --- **`oldValues`**: `StepApprovalRequest` --- **`timestamp`**: `DateTime` # StepApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequestSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[StepApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequestsEdge A Relay edge containing a `StepApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepApprovalRequest` The item at the end of the edge # StepApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRequestsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepApprovalRequestsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepApprovalRequestsInputFilters]` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepApprovalRole Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRole Approval role type for step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`count`**: `Int!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`gateType`**: `Stepapprovalgatetypeenum!` --- **`id`**: `ID` --- **`prettyStr`**: `String` --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepApprovalRoleEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepApprovalRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`count`**: `IntFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `StepapprovalgatetypeenumFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # StepApprovalRoleEvents Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepApprovalRole` --- **`oldValues`**: `StepApprovalRole` --- **`timestamp`**: `DateTime` # StepApprovalRoleSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRoleSortEnum **Kind**: `enum` ## Values **`COUNT_ASC`** **`COUNT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepApprovalRolesConnection Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRolesConnection **Kind**: `object` ## Fields **`edges`**: `[StepApprovalRolesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepApprovalRolesEdge Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRolesEdge A Relay edge containing a `StepApprovalRoles` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepApprovalRole` The item at the end of the edge # StepApprovalRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepApprovalRolesInputFilters StepRoleBasedApprovalRole filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepApprovalRolesInputFilters]` --- **`count`**: `IntFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`gateType`**: `StepapprovalgatetypeenumFilter` --- **`or_`**: `[StepApprovalRolesInputFilters]` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/StepApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[StepApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/StepApprovalsEdge A Relay edge containing a `StepApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepApproval` The item at the end of the edge # StepApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepApprovalsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepAttribute Source: https://docs.firstresonance.io/api-reference/types/StepAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # StepAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`stepId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # StepAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/StepAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepAttribute` --- **`oldValues`**: `StepAttribute` --- **`timestamp`**: `DateTime` # StepAttributedPart Source: https://docs.firstresonance.io/api-reference/types/StepAttributedPart Auto-generated GQL type for StepAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # StepAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[StepAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[StepAttributedPartsInputFilters]` # StepAttributedUser Source: https://docs.firstresonance.io/api-reference/types/StepAttributedUser Auto-generated GQL type for StepAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # StepAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[StepAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[StepAttributedUsersInputFilters]` # StepAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[StepAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[StepAttributesInputFilters]` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # StepEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`displayPdf`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`familyId`**: `IDFilter` --- **`fullPosition`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`intentOptionId`**: `IntFilter` --- **`isDerivedStep`**: `BooleanFilter` --- **`isOutsideProcess`**: `BooleanFilter` --- **`isRoleBased`**: `BooleanFilter` --- **`isStandardStep`**: `BooleanFilter` --- **`leadTime`**: `IntFilter` --- **`locationId`**: `IDFilter` --- **`locationSubtypeId`**: `IDFilter` --- **`originStepId`**: `IDFilter` --- **`pages`**: `IntFilter` --- **`parentId`**: `IDFilter` --- **`pdfAssetId`**: `IDFilter` --- **`position`**: `IntFilter` --- **`procedureId`**: `IDFilter` --- **`standardStepFamilyId`**: `IntFilter` --- **`standardStepId`**: `IDFilter` --- **`standardStepStatus`**: `StandardstepstatusenumFilter` --- **`stepsCount`**: `IntFilter` --- **`title`**: `StringFilter` --- **`type`**: `SteptypesFilter` --- **`updatedById`**: `IDFilter` --- **`version`**: `IntFilter` # StepEvents Source: https://docs.firstresonance.io/api-reference/types/StepEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Step` --- **`oldValues`**: `Step` --- **`timestamp`**: `DateTime` # StepExecution Source: https://docs.firstresonance.io/api-reference/types/StepExecution One execution of a procedure step. Stored telemetry only. **Kind**: `object` ## Fields **`comments`**: `[Comment]` --- **`completedById`**: `Int` --- **`durationSeconds`**: `Float` --- **`endTime`**: `DateTime` --- **`issues`**: `[Issue]` --- **`runId`**: `Int` --- **`runStepId`**: `Int` --- **`startTime`**: `DateTime` --- **`startedById`**: `Int` --- **`status`**: `String` --- **`validationResults`**: `[StepExecutionValidationResultCount]` # StepExecutionEvidence Source: https://docs.firstresonance.io/api-reference/types/StepExecutionEvidence Stratified execution evidence for one procedure step. ``summary`` describes the whole population so the capped samples can be read in proportion — a dozen issues means something different across 2,000 executions than across fifteen. **Kind**: `object` ## Fields **`notableExecutions`**: `[StepExecution]` --- **`procedureFeedback`**: `[Comment]` --- **`recentExecutions`**: `[StepExecution]` --- **`summary`**: `StepExecutionEvidenceSummary` # StepExecutionEvidenceSummary Source: https://docs.firstresonance.io/api-reference/types/StepExecutionEvidenceSummary Counts over every execution of the step, never over the returned samples. **Kind**: `object` ## Fields **`avgDurationSeconds`**: `Float` --- **`distinctOperators`**: `Int` --- **`distinctRuns`**: `Int` --- **`executionsWithComments`**: `Int` --- **`executionsWithFailedValidation`**: `Int` --- **`executionsWithIssues`**: `Int` --- **`firstStartedAt`**: `DateTime` --- **`lastStartedAt`**: `DateTime` --- **`statusCounts`**: `[StepExecutionStatusCount]` --- **`totalExecutions`**: `Int` # StepExecutionStatusCount Source: https://docs.firstresonance.io/api-reference/types/StepExecutionStatusCount Executions of a procedure step that ended in a given status. **Kind**: `object` ## Fields **`count`**: `Int` --- **`status`**: `String` # StepExecutionValidationResultCount Source: https://docs.firstresonance.io/api-reference/types/StepExecutionValidationResultCount Field validations on one execution that landed on a given result. **Kind**: `object` ## Fields **`count`**: `Int` --- **`result`**: `String` # StepField Source: https://docs.firstresonance.io/api-reference/types/StepField A field related to a step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_ValidationsCount`**: `Int` Optimized count of validations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`allowNotApplicable`**: `Boolean!` --- **`allowedIonType`**: `stepfieldiontypeentitytypeenum` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`display`**: `String` --- **`editable`**: `Boolean` --- **`helpText`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`options`**: `[String]` --- **`part`**: `Part` Return part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int` Return part foreign key relation. --- **`partSubtype`**: `PartSubtype` Return part subtype relationship. **Arguments:** - `filters`: `PartSubtypesInputFilters` --- **`partSubtypeId`**: `Int` Return part subtype foreign key relation. --- **`peerReviewRequired`**: `Boolean!` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`required`**: `Boolean!` --- **`signoffRole`**: `Role` Get Role for signoff. Returns: relationship object **Arguments:** - `filters`: `RolesInputFilters` --- **`signoffRoleId`**: `Int` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepFieldEventFilter` --- **`type`**: `Fieldtypes!` --- **`unit`**: `String` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`validations`**: `[StepFieldValidation]` **Arguments:** - `filters`: `StepFieldValidationsInputFilters` # StepFieldEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepFieldEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowNotApplicable`**: `BooleanFilter` --- **`allowedIonType`**: `stepfieldiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`display`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`helpText`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`partId`**: `IDFilter` --- **`partSubtypeId`**: `IDFilter` --- **`peerReviewRequired`**: `BooleanFilter` --- **`position`**: `IntFilter` --- **`required`**: `BooleanFilter` --- **`signoffRoleId`**: `IDFilter` --- **`stepId`**: `IDFilter` --- **`type`**: `FieldtypesFilter` --- **`unit`**: `StringFilter` --- **`updatedById`**: `IDFilter` # StepFieldEvents Source: https://docs.firstresonance.io/api-reference/types/StepFieldEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepField` --- **`oldValues`**: `StepField` --- **`timestamp`**: `DateTime` # StepFieldSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepFieldSortEnum **Kind**: `enum` ## Values **`ALLOWED_ION_TYPE_ASC`** **`ALLOWED_ION_TYPE_DESC`** **`ALLOW_NOT_APPLICABLE_ASC`** **`ALLOW_NOT_APPLICABLE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DISPLAY_ASC`** **`DISPLAY_DESC`** **`HELP_TEXT_ASC`** **`HELP_TEXT_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`OPTIONS_ASC`** **`OPTIONS_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`PART_SUBTYPE_ID_ASC`** **`PART_SUBTYPE_ID_DESC`** **`PEER_REVIEW_REQUIRED_ASC`** **`PEER_REVIEW_REQUIRED_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`REQUIRED_ASC`** **`REQUIRED_DESC`** **`SIGNOFF_ROLE_ID_ASC`** **`SIGNOFF_ROLE_ID_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UNIT_ASC`** **`UNIT_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidation step field validation GraphQL object. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`field`**: `StepField` **Arguments:** - `filters`: `FieldsInputFilters` --- **`fieldId`**: `Int` --- **`function`**: `ValidationFunction` Return function related to validation object. **Arguments:** - `filters`: `ValidationFunctionsInputFilters` --- **`functionId`**: `Int!` Return foriegn key relation from validation to function. --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`position`**: `Int` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepFieldValidationEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `Float` # StepFieldValidationEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fieldId`**: `IDFilter` --- **`functionId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`position`**: `IntFilter` --- **`updatedById`**: `IDFilter` --- **`value`**: `FloatFilter` # StepFieldValidationEvents Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepFieldValidation` --- **`oldValues`**: `StepFieldValidation` --- **`timestamp`**: `DateTime` # StepFieldValidationSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidationSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`FIELD_ID_ASC`** **`FIELD_ID_DESC`** **`FUNCTION_ID_ASC`** **`FUNCTION_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepFieldValidationsConnection Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidationsConnection **Kind**: `object` ## Fields **`edges`**: `[StepFieldValidationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepFieldValidationsEdge Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidationsEdge A Relay edge containing a `StepFieldValidations` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepFieldValidation` The item at the end of the edge # StepFieldValidationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepFieldValidationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepFieldValidationsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`field`**: `FieldsInputFilters` --- **`fieldId`**: `IDFilter` --- **`function`**: `ValidationFunctionsInputFilters` --- **`functionId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepFieldValidationsInputFilters]` --- **`position`**: `IntFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `FloatFilter` # StepPagesInput Source: https://docs.firstresonance.io/api-reference/types/StepPagesInput Inputs to map PDF pages to a step. **Kind**: `input` ## Fields **`pages`**: `[Int]!` (required) --- **`title`**: `String` # StepPartRequirement Source: https://docs.firstresonance.io/api-reference/types/StepPartRequirement Step part requirement to manufacture. **Kind**: `object` ## Fields **`Deleted`**: `Boolean!` --- **`LastSessionId`**: `String` --- **`_AssignedReferenceDesignatorsCount`**: `Int` Optimized count of assignedReferenceDesignators. --- **`_ProcedureReferenceDesignatorsCount`**: `Int` Optimized count of procedureReferenceDesignators. --- **`_ReferenceDesignatorAssignmentsCount`**: `Int` Optimized count of referenceDesignatorAssignments. --- **`_ReferenceDesignatorsCount`**: `Int` Optimized count of referenceDesignators. --- **`_RunStepBuildRequirementsCount`**: `Int` Optimized count of runStepBuildRequirements. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedReferenceDesignators`**: `[MBomItemReferenceDesignator]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`mbomItem`**: `MBomItem` **Arguments:** - `filters`: `MBomItemsInputFilters` --- **`mbomItemId`**: `Int!` --- **`prettyStr`**: `String` --- **`procedureId`**: `Int!` --- **`procedureMbom`**: `ProcedureMBom` --- **`procedureMbomItem`**: `ProcedureMBomItem` --- **`procedureReferenceDesignators`**: `[ProcedureReferenceDesignator]` **Arguments:** - `filters`: `ProcedureReferenceDesignatorsInputFilters` --- **`quantity`**: `Float!` --- **`referenceDesignators`**: `[MBomItemReferenceDesignator]` --- **`runStepBuildRequirements`**: `[RunStepBuildRequirement]` **Arguments:** - `filters`: `RunStepBuildRequirementsInputFilters` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepPartRequirementSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepPartRequirementSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`MBOM_ITEM_ID_ASC`** **`MBOM_ITEM_ID_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`QUANTITY_ASC`** **`QUANTITY_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_DELETED_ASC`** **`_DELETED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepPartRequirementsConnection Source: https://docs.firstresonance.io/api-reference/types/StepPartRequirementsConnection **Kind**: `object` ## Fields **`edges`**: `[StepPartRequirementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepPartRequirementsEdge Source: https://docs.firstresonance.io/api-reference/types/StepPartRequirementsEdge A Relay edge containing a `StepPartRequirements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepPartRequirement` The item at the end of the edge # StepPartRequirementsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepPartRequirementsInputFilters StepPartAssociation filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_deleted`**: `BooleanFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepPartRequirementsInputFilters]` --- **`assignedReferenceDesignators`**: `MBomItemReferenceDesignatorsInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`mbomItem`**: `MBomItemsInputFilters` --- **`mbomItemId`**: `IDFilter` --- **`or_`**: `[StepPartRequirementsInputFilters]` --- **`procedureId`**: `IDFilter` --- **`procedureMbom`**: `ProcedureMBomsInputFilters` --- **`procedureMbomItem`**: `ProcedureMBomItemsInputFilters` --- **`procedureReferenceDesignators`**: `ProcedureReferenceDesignatorsInputFilters` --- **`quantity`**: `FloatFilter` --- **`referenceDesignators`**: `MBomItemReferenceDesignatorsInputFilters` --- **`runStepBuildRequirements`**: `RunStepBuildRequirementsInputFilters` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepProposal Source: https://docs.firstresonance.io/api-reference/types/StepProposal A proposed replacement for one procedure step's content. List by step with `filters: {stepId: {eq: $id}}`, and by procedure with `filters: {step: {procedureId: {eq: $id}}}`. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`acceptedEtag`**: `String` --- **`applicationPreview`**: `StepProposalApplicationPreview` Current result and applicability of accepting the proposal. --- **`baseEtag`**: `String!` --- **`changeSummary`**: `String!` --- **`clearedAt`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`proposedContent`**: `String` --- **`proposedSlateContent`**: `SlateContent` --- **`proposedTitle`**: `String` --- **`replacedContent`**: `String` --- **`replacedSlateContent`**: `SlateContent` --- **`replacedTitle`**: `String` --- **`state`**: `Stepproposalstateenum!` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`supersedes`**: `StepProposal` --- **`supersedesId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepProposalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepProposalApplicationPreview Source: https://docs.firstresonance.io/api-reference/types/StepProposalApplicationPreview The result this proposal would write onto the step as it exists now. **Kind**: `object` ## Fields **`applicable`**: `Boolean!` Whether the proposal can currently be accepted. --- **`conflictMessage`**: `String` Reason the proposal cannot currently be accepted. --- **`content`**: `String` Plain-text content after applying the proposal. --- **`slateContent`**: `SlateContent` Structured content after applying the proposal. --- **`title`**: `String` Step title after applying the proposal. # StepProposalEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepProposalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`acceptedEtag`**: `StringFilter` --- **`actor`**: `UserInputFilters` --- **`baseEtag`**: `StringFilter` --- **`clearedAt`**: `DateTimeFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`proposedTitle`**: `StringFilter` --- **`replacedTitle`**: `StringFilter` --- **`state`**: `StepproposalstateenumFilter` --- **`stepId`**: `IDFilter` --- **`supersedesId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # StepProposalEvents Source: https://docs.firstresonance.io/api-reference/types/StepProposalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepProposal` --- **`oldValues`**: `StepProposal` --- **`timestamp`**: `DateTime` # StepProposalSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepProposalSortEnum **Kind**: `enum` ## Values **`ACCEPTED_ETAG_ASC`** **`ACCEPTED_ETAG_DESC`** **`BASE_ETAG_ASC`** **`BASE_ETAG_DESC`** **`CHANGE_SUMMARY_ASC`** **`CHANGE_SUMMARY_DESC`** **`CLEARED_AT_ASC`** **`CLEARED_AT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PROPOSED_CONTENT_ASC`** **`PROPOSED_CONTENT_DESC`** **`PROPOSED_TITLE_ASC`** **`PROPOSED_TITLE_DESC`** **`REPLACED_CONTENT_ASC`** **`REPLACED_CONTENT_DESC`** **`REPLACED_TITLE_ASC`** **`REPLACED_TITLE_DESC`** **`STATE_ASC`** **`STATE_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`SUPERSEDES_ID_ASC`** **`SUPERSEDES_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepProposalsConnection Source: https://docs.firstresonance.io/api-reference/types/StepProposalsConnection **Kind**: `object` ## Fields **`edges`**: `[StepProposalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepProposalsEdge Source: https://docs.firstresonance.io/api-reference/types/StepProposalsEdge A Relay edge containing a `StepProposals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepProposal` The item at the end of the edge # StepProposalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepProposalsInputFilters StepProposal filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`acceptedEtag`**: `StringFilter` --- **`and_`**: `[StepProposalsInputFilters]` --- **`baseEtag`**: `StringFilter` --- **`clearedAt`**: `DateTimeFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepProposalsInputFilters]` --- **`proposedTitle`**: `StringFilter` --- **`replacedTitle`**: `StringFilter` --- **`state`**: `StepproposalstateenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`supersedesId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApproval An approval related to an step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RepliesCount`**: `Int` Optimized count of replies. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`comment`**: `String` --- **`content`**: `SlateContent` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`depth`**: `Int!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Stepapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`parent`**: `StepRoleBasedApproval` --- **`parentId`**: `Int` Return foreign key referencing the same class. --- **`prettyStr`**: `String` --- **`replies`**: `[StepRoleBasedApproval]` --- **`resolved`**: `Boolean!` --- **`reviewer`**: `User` Return the reviewer relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`reviewerId`**: `Int!` Return the reviewer id. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepRoleBasedApprovalEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepRoleBasedApprovalEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentFilter` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `StepapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewerId`**: `IDFilter` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # StepRoleBasedApprovalEvents Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepRoleBasedApproval` --- **`oldValues`**: `StepRoleBasedApproval` --- **`timestamp`**: `DateTime` # StepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequest A request to approve an procedure. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_AssigneesCount`**: `Int` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`assignedTeam`**: `Team` Team that the object is assigned to. **Arguments:** - `filters`: `TeamsInputFilters` --- **`assignedTeamId`**: `Int` Team id that the object is assigned to. --- **`assignedTo`**: `User` User that the object is assigned to. **Arguments:** - `filters`: `UserInputFilters` --- **`assignedToId`**: `Int` User id that the object is assigned to. --- **`assignees`**: `[User]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`gateType`**: `Stepapprovalgatetypeenum!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`reviewer`**: `User` > Deprecated: The field reviewer has been replaced in favor of assignedTo. --- **`reviewerId`**: `Int` > Deprecated: The field reviewerId has been replaced in favor of assignedToId. --- **`role`**: `Role` Return the role relationship. **Arguments:** - `filters`: `RolesInputFilters` --- **`roleId`**: `Int` Return the role_id. --- **`status`**: `reviewreviewstatusenum` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepRoleBasedApprovalRequestEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # StepRoleBasedApprovalRequestEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequestEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedToId`**: `IDFilter` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`gateType`**: `StepapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # StepRoleBasedApprovalRequestEvents Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequestEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepRoleBasedApprovalRequest` --- **`oldValues`**: `StepRoleBasedApprovalRequest` --- **`timestamp`**: `DateTime` # StepRoleBasedApprovalRequestSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequestSortEnum **Kind**: `enum` ## Values **`ASSIGNED_TEAM_ID_ASC`** **`ASSIGNED_TEAM_ID_DESC`** **`ASSIGNED_TO_ID_ASC`** **`ASSIGNED_TO_ID_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepRoleBasedApprovalRequestsConnection Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequestsConnection **Kind**: `object` ## Fields **`edges`**: `[StepRoleBasedApprovalRequestsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepRoleBasedApprovalRequestsEdge Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequestsEdge A Relay edge containing a `StepRoleBasedApprovalRequests` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepRoleBasedApprovalRequest` The item at the end of the edge # StepRoleBasedApprovalRequestsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalRequestsInputFilters StepRoleBasedApprovalRequest filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepRoleBasedApprovalRequestsInputFilters]` --- **`assignedTeam`**: `TeamsInputFilters` --- **`assignedTeamId`**: `IDFilter` --- **`assignedTo`**: `UserInputFilters` --- **`assignedToId`**: `IDFilter` --- **`assignees`**: `UserInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `StepapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepRoleBasedApprovalRequestsInputFilters]` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IntFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepRoleBasedApprovalSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalSortEnum **Kind**: `enum` ## Values **`COMMENT_ASC`** **`COMMENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEPTH_ASC`** **`DEPTH_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`GATE_TYPE_ASC`** **`GATE_TYPE_DESC`** **`ID_ASC`** **`ID_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`RESOLVED_ASC`** **`RESOLVED_DESC`** **`REVIEWER_ID_ASC`** **`REVIEWER_ID_DESC`** **`ROLE_ID_ASC`** **`ROLE_ID_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`STEP_ID_ASC`** **`STEP_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # StepRoleBasedApprovalsConnection Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalsConnection **Kind**: `object` ## Fields **`edges`**: `[StepRoleBasedApprovalsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # StepRoleBasedApprovalsEdge Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalsEdge A Relay edge containing a `StepRoleBasedApprovals` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `StepRoleBasedApproval` The item at the end of the edge # StepRoleBasedApprovalsInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepRoleBasedApprovalsInputFilters StepRoleBasedApproval filterable fields. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepRoleBasedApprovalsInputFilters]` --- **`comment`**: `StringFilter` --- **`content`**: `SlateContentNullFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`depth`**: `IntFilter` --- **`entityId`**: `IDFilter` --- **`gateType`**: `StepapprovalgatetypeenumFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepRoleBasedApprovalsInputFilters]` --- **`parentId`**: `IDFilter` --- **`resolved`**: `BooleanFilter` --- **`reviewer`**: `UserInputFilters` --- **`reviewerId`**: `IDFilter` --- **`role`**: `RolesInputFilters` --- **`roleId`**: `IDFilter` --- **`status`**: `reviewreviewstatusenumFilter` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # StepSettings Source: https://docs.firstresonance.io/api-reference/types/StepSettings Settings related to steps. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` --- **`numApproversRequired`**: `Int` # StepSettingsInput Source: https://docs.firstresonance.io/api-reference/types/StepSettingsInput Input settings related to steps. **Kind**: `input` ## Fields **`numApproversRequired`**: `Int` # StepSortEnum Source: https://docs.firstresonance.io/api-reference/types/StepSortEnum **Kind**: `enum` ## Values **`CONTENT_ASC`** **`CONTENT_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DISPLAY_PDF_ASC`** **`DISPLAY_PDF_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`FAMILY_ID_ASC`** **`FAMILY_ID_DESC`** **`FULL_POSITION_ASC`** **`FULL_POSITION_DESC`** **`ID_ASC`** **`ID_DESC`** **`INTENT_OPTION_ID_ASC`** **`INTENT_OPTION_ID_DESC`** **`IS_DERIVED_STEP_ASC`** **`IS_DERIVED_STEP_DESC`** **`IS_OUTSIDE_PROCESS_ASC`** **`IS_OUTSIDE_PROCESS_DESC`** **`IS_ROLE_BASED_ASC`** **`IS_ROLE_BASED_DESC`** **`IS_STANDARD_STEP_ASC`** **`IS_STANDARD_STEP_DESC`** **`LEAD_TIME_ASC`** **`LEAD_TIME_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`LOCATION_SUBTYPE_ID_ASC`** **`LOCATION_SUBTYPE_ID_DESC`** **`ORIGIN_STEP_ID_ASC`** **`ORIGIN_STEP_ID_DESC`** **`PAGES_ASC`** **`PAGES_DESC`** **`PARENT_ID_ASC`** **`PARENT_ID_DESC`** **`PDF_ASSET_ID_ASC`** **`PDF_ASSET_ID_DESC`** **`POSITION_ASC`** **`POSITION_DESC`** **`PROCEDURE_ID_ASC`** **`PROCEDURE_ID_DESC`** **`STANDARD_STEP_FAMILY_ID_ASC`** **`STANDARD_STEP_FAMILY_ID_DESC`** **`STANDARD_STEP_ID_ASC`** **`STANDARD_STEP_ID_DESC`** **`STANDARD_STEP_STATUS_ASC`** **`STANDARD_STEP_STATUS_DESC`** **`STEPS_COUNT_ASC`** **`STEPS_COUNT_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VERSION_ASC`** **`VERSION_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # Stepapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/Stepapprovalgatetypeenum **Kind**: `enum` ## Values **`RELEASED`** # StepapprovalgatetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/StepapprovalgatetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Stepapprovalgatetypeenum` --- **`gt`**: `Stepapprovalgatetypeenum` --- **`gte`**: `Stepapprovalgatetypeenum` --- **`ilike`**: `Stepapprovalgatetypeenum` --- **`in`**: `[Stepapprovalgatetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Stepapprovalgatetypeenum` --- **`lt`**: `Stepapprovalgatetypeenum` --- **`lte`**: `Stepapprovalgatetypeenum` --- **`neq`**: `Stepapprovalgatetypeenum` --- **`notilike`**: `Stepapprovalgatetypeenum` --- **`notlike`**: `Stepapprovalgatetypeenum` # Stepproposalstateenum Source: https://docs.firstresonance.io/api-reference/types/Stepproposalstateenum **Kind**: `enum` ## Values **`ACCEPTED`** **`DISMISSED`** **`INVALIDATED`** **`PENDING`** **`SUPERSEDED`** # StepproposalstateenumFilter Source: https://docs.firstresonance.io/api-reference/types/StepproposalstateenumFilter **Kind**: `input` ## Fields **`eq`**: `Stepproposalstateenum` --- **`gt`**: `Stepproposalstateenum` --- **`gte`**: `Stepproposalstateenum` --- **`ilike`**: `Stepproposalstateenum` --- **`in`**: `[Stepproposalstateenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Stepproposalstateenum` --- **`lt`**: `Stepproposalstateenum` --- **`lte`**: `Stepproposalstateenum` --- **`neq`**: `Stepproposalstateenum` --- **`notilike`**: `Stepproposalstateenum` --- **`notlike`**: `Stepproposalstateenum` # StepsEdge Source: https://docs.firstresonance.io/api-reference/types/StepsEdge A Step's relationship to another Step. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`step`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`stepId`**: `Int!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `StepsEdgeEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`upstreamStep`**: `Step` **Arguments:** - `filters`: `StepsFilters` --- **`upstreamStepId`**: `Int` # StepsEdgeEventFilter Source: https://docs.firstresonance.io/api-reference/types/StepsEdgeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`stepId`**: `IDFilter` --- **`updatedById`**: `IDFilter` --- **`upstreamStepId`**: `IDFilter` # StepsEdgeEvents Source: https://docs.firstresonance.io/api-reference/types/StepsEdgeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `StepsEdge` --- **`oldValues`**: `StepsEdge` --- **`timestamp`**: `DateTime` # StepsEdgesInputFilters Source: https://docs.firstresonance.io/api-reference/types/StepsEdgesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[StepsEdgesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[StepsEdgesInputFilters]` --- **`step`**: `StepsFilters` --- **`stepId`**: `IDFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`upstreamStep`**: `StepsFilters` --- **`upstreamStepId`**: `IDFilter` # StepsFilters Source: https://docs.firstresonance.io/api-reference/types/StepsFilters StepsFilters are filterable input types for Steps. **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allChildren`**: `StepsFilters` --- **`allParents`**: `StepsFilters` --- **`and_`**: `[StepsFilters]` --- **`approvalRequests`**: `StepApprovalRequestsInputFilters` --- **`approvals`**: `StepApprovalsInputFilters` --- **`attributedParts`**: `StepAttributedPartsInputFilters` --- **`attributedUsers`**: `StepAttributedUsersInputFilters` --- **`attributes`**: `StepAttributesInputFilters` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`datagridColumns`**: `DatagridColumnsInputFilters` --- **`datagridRows`**: `DatagridRowsInputFilters` --- **`displayPdf`**: `BooleanFilter` --- **`downstream`**: `StepsEdgesInputFilters` --- **`editable`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`familyId`**: `IDFilter` --- **`fields`**: `FieldsInputFilters` --- **`fullPosition`**: `StringFilter` --- **`id`**: `IDFilter` --- **`intentOption`**: `IntentOptionsInputFilters` --- **`intentOptionId`**: `IntFilter` --- **`isChildStandardStep`**: `BooleanFilter` --- **`isDerivedStep`**: `BooleanFilter` --- **`isLatestReleasedVersion`**: `BooleanFilter` --- **`isLatestVersion`**: `BooleanFilter` --- **`isOutsideProcess`**: `BooleanFilter` --- **`isRoleBased`**: `BooleanFilter` --- **`isStandardStep`**: `BooleanFilter` --- **`labels`**: `LabelsInputFilters` --- **`leadTime`**: `IntFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`locationSubtype`**: `LocationSubtypesInputFilters` --- **`locationSubtypeId`**: `IDFilter` --- **`or_`**: `[StepsFilters]` --- **`originStepId`**: `IDFilter` --- **`pages`**: `IntFilter` --- **`parentId`**: `IDFilter` --- **`pdf`**: `FileAttachmentsInputFilters` --- **`pdfAssetId`**: `IDFilter` --- **`position`**: `IntFilter` --- **`procedure`**: `ProceduresInputFilters` --- **`procedureApprovals`**: `ProcedureApprovalsInputFilters` --- **`procedureId`**: `IDFilter` --- **`procedureReferenceDesignators`**: `ProcedureReferenceDesignatorsInputFilters` --- **`reviews`**: `ReviewsInputFilters` --- **`roleBasedApprovalRequests`**: `StepRoleBasedApprovalRequestsInputFilters` --- **`roleBasedApprovals`**: `StepRoleBasedApprovalsInputFilters` --- **`standardStepFamilyId`**: `IntFilter` --- **`standardStepId`**: `IDFilter` --- **`standardStepStatus`**: `StandardstepstatusenumFilter` --- **`stepsCount`**: `IntFilter` --- **`title`**: `StringFilter` --- **`type`**: `SteptypesFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`upstream`**: `StepsEdgesInputFilters` --- **`version`**: `IntFilter` # Steptypes Source: https://docs.firstresonance.io/api-reference/types/Steptypes **Kind**: `enum` ## Values **`CONTENT`** **`DATAGRID`** # SteptypesFilter Source: https://docs.firstresonance.io/api-reference/types/SteptypesFilter **Kind**: `input` ## Fields **`eq`**: `Steptypes` --- **`gt`**: `Steptypes` --- **`gte`**: `Steptypes` --- **`ilike`**: `Steptypes` --- **`in`**: `[Steptypes]` --- **`isnull`**: `Boolean` --- **`like`**: `Steptypes` --- **`lt`**: `Steptypes` --- **`lte`**: `Steptypes` --- **`neq`**: `Steptypes` --- **`notilike`**: `Steptypes` --- **`notlike`**: `Steptypes` # StringFilter Source: https://docs.firstresonance.io/api-reference/types/StringFilter **Kind**: `input` ## Fields **`eq`**: `String` --- **`fuzzyMatch`**: `StringFuzzyMatchFilter` --- **`gt`**: `String` --- **`gte`**: `String` --- **`ilike`**: `String` --- **`in`**: `[String]` --- **`isnull`**: `Boolean` --- **`like`**: `String` --- **`lt`**: `String` --- **`lte`**: `String` --- **`neq`**: `String` --- **`notilike`**: `String` --- **`notlike`**: `String` # StringFuzzyMatchFilter Source: https://docs.firstresonance.io/api-reference/types/StringFuzzyMatchFilter **Kind**: `input` ## Fields **`similarity`**: `Float` = 0.5 ('Float value between 0 and 1, with 1 being a direct string ', 'match. The higher the similarity value the closer two string ', 'must be in order to be considered a match.') --- **`value`**: `String` # SubmitChangeOrder Source: https://docs.firstresonance.io/api-reference/types/SubmitChangeOrder Submit a draft change order for review. **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # SubmitRunAbomJustification Source: https://docs.firstresonance.io/api-reference/types/SubmitRunAbomJustification Submit the ABOM completion justification, marking it as formally submitted. **Kind**: `object` ## Fields **`run`**: `Run` # SubmitRunAbomJustificationInput Source: https://docs.firstresonance.io/api-reference/types/SubmitRunAbomJustificationInput Input for formally submitting the ABOM completion justification. **Kind**: `input` ## Fields **`runId`**: `Int!` (required) # SumField Source: https://docs.firstresonance.io/api-reference/types/SumField Sum field for getting aggregate sums for integer and float fields of a given graphql connection. **Kind**: `object` ## Fields **`quantity`**: `Float` Sum of field quantity. --- **`quantityAvailable`**: `Float` Sum of field quantityAvailable. # Supplier Source: https://docs.firstresonance.io/api-reference/types/Supplier A Supplier of parts. **Kind**: `object` ## Fields **`Attributes`**: `[SupplierAttribute]` **Arguments:** - `filters`: `SupplierAttributesInputFilters` --- **`LastSessionId`**: `String` --- **`_AttributedPartsCount`**: `Int` Optimized count of attributedParts. --- **`_AttributedUsersCount`**: `Int` Optimized count of attributedUsers. --- **`_AttributesCount`**: `Int` Optimized count of attributes. --- **`_CommentsCount`**: `Int` Optimized count of comments. --- **`_LabelsCount`**: `Int` Optimized count of labels. --- **`_PartsInventoriesCount`**: `Int` Optimized count of partsInventories. --- **`_PlanItemsCount`**: `Int` Optimized count of planItems. --- **`_PurchaseOrdersCount`**: `Int` Optimized count of purchaseOrders. --- **`_SupplierPartsCount`**: `Int` Optimized count of supplierParts. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`address`**: `String` --- **`attributedParts`**: `[SupplierAttributedPart]` **Arguments:** - `filters`: `SupplierAttributedPartsInputFilters` --- **`attributedUsers`**: `[SupplierAttributedUser]` **Arguments:** - `filters`: `SupplierAttributedUsersInputFilters` --- **`attributes`**: `[SupplierAttribute]` --- **`comments`**: `[Comment]` --- **`contactName`**: `String` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`email`**: `String` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`fileAttachments`**: `[FileAttachment]` --- **`id`**: `Int!` --- **`labels`**: `[Label]` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`partsInventories`**: `[PartInventory]` --- **`phoneNumber`**: `String` --- **`planItems`**: `[PlanItem]` **Arguments:** - `filters`: `PlanItemsInputFilters` --- **`prettyStr`**: `String` --- **`purchaseOrders`**: `[PurchaseOrder]` **Arguments:** - `filters`: `PurchaseOrdersInputFilters` --- **`supplierParts`**: `[SupplierPart]` **Arguments:** - `filters`: `SupplierPartsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SupplierEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # SupplierAttribute Source: https://docs.firstresonance.io/api-reference/types/SupplierAttribute **Kind**: `object` ## Fields **`Created`**: `DateTime` --- **`Etag`**: `String!` --- **`LastSessionId`**: `String` --- **`Updated`**: `DateTime` --- **`_IonValueCount`**: `Int` --- **`_ValueCount`**: `Int` --- **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archivedOptions`**: `[String]` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`criticality`**: `extensibleattributecriticalityenum` --- **`entity`**: `Entity` --- **`entityId`**: `Int` --- **`fileAttachment`**: `FileAttachment` Return file attachment relationship. **Arguments:** - `filters`: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `Int` Return fileattachment foreign key relation. --- **`id`**: `String` --- **`ionValue`**: `IonType` --- **`key`**: `String!` --- **`options`**: `[String]` --- **`prettyStr`**: `String` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SupplierAttributeEventFilter` --- **`type`**: `reviewattrtypesenum` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `ScalarValue` # SupplierAttributeEventFilter Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributeEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`supplierId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedById`**: `IDFilter` # SupplierAttributeEvents Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributeEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `SupplierAttribute` --- **`oldValues`**: `SupplierAttribute` --- **`timestamp`**: `DateTime` # SupplierAttributedPart Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributedPart Auto-generated GQL type for SupplierAttributedPart **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedPart`**: `Part` Define part relationship. **Arguments:** - `filters`: `PartsInputFilters` --- **`attributedPartId`**: `Int` Define part id foreign key. --- **`key`**: `String!` # SupplierAttributedPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributedPartsInputFilters **Kind**: `input` ## Fields **`and_`**: `[SupplierAttributedPartsInputFilters]` --- **`attributedPart`**: `PartsInputFilters` --- **`attributedPartId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[SupplierAttributedPartsInputFilters]` # SupplierAttributedUser Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributedUser Auto-generated GQL type for SupplierAttributedUser **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`attributedUser`**: `User` Define user relationship. **Arguments:** - `filters`: `UserInputFilters` --- **`attributedUserId`**: `Int` Define user id foreign key. --- **`key`**: `String!` # SupplierAttributedUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributedUsersInputFilters **Kind**: `input` ## Fields **`and_`**: `[SupplierAttributedUsersInputFilters]` --- **`attributedUser`**: `UserInputFilters` --- **`attributedUserId`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[SupplierAttributedUsersInputFilters]` # SupplierAttributesInputFilters Source: https://docs.firstresonance.io/api-reference/types/SupplierAttributesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`allowedIonType`**: `organizationiontypeentitytypeenumFilter` --- **`and_`**: `[SupplierAttributesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`criticality`**: `extensibleattributecriticalityenumFilter` --- **`entityId`**: `IDFilter` --- **`fileAttachment`**: `FileAttachmentsInputFilters` --- **`fileAttachmentId`**: `IDFilter` --- **`id`**: `StringFilter` --- **`key`**: `StringFilter` --- **`options`**: `StringFilter` --- **`or_`**: `[SupplierAttributesInputFilters]` --- **`supplier`**: `SuppliersInputFilters` --- **`supplierId`**: `IDFilter` --- **`type`**: `reviewattrtypesenumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `ScalarValueFilter` # SupplierEventFilter Source: https://docs.firstresonance.io/api-reference/types/SupplierEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`address`**: `StringFilter` --- **`contactName`**: `StringFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`email`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`phoneNumber`**: `StringFilter` --- **`updatedById`**: `IDFilter` # SupplierEvents Source: https://docs.firstresonance.io/api-reference/types/SupplierEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Supplier` --- **`oldValues`**: `Supplier` --- **`timestamp`**: `DateTime` # SupplierPart Source: https://docs.firstresonance.io/api-reference/types/SupplierPart Supplier-specific part numbers, and their UoM conversion factor to the ION part's UoM. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_PurchaseOrderLinesCount`**: `Int` Optimized count of purchaseOrderLines. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`conversionFactor`**: `Float!` --- **`cost`**: `Float` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`part`**: `Part` **Arguments:** - `filters`: `PartsInputFilters` --- **`partId`**: `Int!` --- **`prettyStr`**: `String` --- **`purchaseOrderLines`**: `[PurchaseOrderLine]` **Arguments:** - `filters`: `PurchaseOrderLinesInputFilters` --- **`supplier`**: `Supplier` **Arguments:** - `filters`: `SuppliersInputFilters` --- **`supplierId`**: `Int!` --- **`supplierPartNumber`**: `String!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `SupplierPartEventFilter` --- **`unitOfMeasure`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # SupplierPartEventFilter Source: https://docs.firstresonance.io/api-reference/types/SupplierPartEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`conversionFactor`**: `FloatFilter` --- **`cost`**: `FloatFilter` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`partId`**: `IDFilter` --- **`supplierId`**: `IDFilter` --- **`supplierPartNumber`**: `StringFilter` --- **`unitOfMeasure`**: `StringFilter` --- **`updatedById`**: `IDFilter` # SupplierPartEvents Source: https://docs.firstresonance.io/api-reference/types/SupplierPartEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `SupplierPart` --- **`oldValues`**: `SupplierPart` --- **`timestamp`**: `DateTime` # SupplierPartSortEnum Source: https://docs.firstresonance.io/api-reference/types/SupplierPartSortEnum **Kind**: `enum` ## Values **`CONVERSION_FACTOR_ASC`** **`CONVERSION_FACTOR_DESC`** **`COST_ASC`** **`COST_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`PART_ID_ASC`** **`PART_ID_DESC`** **`SUPPLIER_ID_ASC`** **`SUPPLIER_ID_DESC`** **`SUPPLIER_PART_NUMBER_ASC`** **`SUPPLIER_PART_NUMBER_DESC`** **`UNIT_OF_MEASURE_ASC`** **`UNIT_OF_MEASURE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # SupplierPartsConnection Source: https://docs.firstresonance.io/api-reference/types/SupplierPartsConnection **Kind**: `object` ## Fields **`edges`**: `[SupplierPartsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # SupplierPartsEdge Source: https://docs.firstresonance.io/api-reference/types/SupplierPartsEdge A Relay edge containing a `SupplierParts` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `SupplierPart` The item at the end of the edge # SupplierPartsInputFilters Source: https://docs.firstresonance.io/api-reference/types/SupplierPartsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[SupplierPartsInputFilters]` --- **`conversionFactor`**: `FloatFilter` --- **`cost`**: `FloatFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[SupplierPartsInputFilters]` --- **`part`**: `PartsInputFilters` --- **`partId`**: `IDFilter` --- **`purchaseOrderLines`**: `PurchaseOrderLinesInputFilters` --- **`supplier`**: `SuppliersInputFilters` --- **`supplierId`**: `IDFilter` --- **`supplierPartNumber`**: `StringFilter` --- **`unitOfMeasure`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # SupplierSettings Source: https://docs.firstresonance.io/api-reference/types/SupplierSettings Organization settings related to suppliers. **Kind**: `object` ## Fields **`attributes`**: `[AttributeSettings]` # SupplierSortEnum Source: https://docs.firstresonance.io/api-reference/types/SupplierSortEnum **Kind**: `enum` ## Values **`ADDRESS_ASC`** **`ADDRESS_DESC`** **`CONTACT_NAME_ASC`** **`CONTACT_NAME_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`EMAIL_ASC`** **`EMAIL_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`PHONE_NUMBER_ASC`** **`PHONE_NUMBER_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # SuppliersConnection Source: https://docs.firstresonance.io/api-reference/types/SuppliersConnection **Kind**: `object` ## Fields **`edges`**: `[SuppliersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # SuppliersEdge Source: https://docs.firstresonance.io/api-reference/types/SuppliersEdge A Relay edge containing a `Suppliers` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Supplier` The item at the end of the edge # SuppliersInputFilters Source: https://docs.firstresonance.io/api-reference/types/SuppliersInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`address`**: `StringFilter` --- **`and_`**: `[SuppliersInputFilters]` --- **`attributedParts`**: `SupplierAttributedPartsInputFilters` --- **`attributedUsers`**: `SupplierAttributedUsersInputFilters` --- **`attributes`**: `SupplierAttributesInputFilters` --- **`contactName`**: `StringFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`email`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[SuppliersInputFilters]` --- **`phoneNumber`**: `StringFilter` --- **`planItems`**: `PlanItemsInputFilters` --- **`purchaseOrders`**: `PurchaseOrdersInputFilters` --- **`supplierParts`**: `SupplierPartsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # TableNameEnum Source: https://docs.firstresonance.io/api-reference/types/TableNameEnum **Kind**: `enum` ## Values **`ABOM_INSTALLATIONS`** **`AI_CONSENT_WITHDRAWALS`** **`AI_TOS_ACCEPTANCES`** **`ANALYTICS_CREDENTIALS`** **`API_KEYS`** **`APPROVAL_LEVELS`** **`BARCODE_LABELS`** **`BARCODE_PATTERNS`** **`BARCODE_PRINT_REQUESTS`** **`BARCODE_TEMPLATES`** **`BUILD_REQUIREMENTS`** **`BUILD_REQUIREMENT_REFERENCE_DESIGNATORS`** **`BUILD_REQUIREMENT_SUBSTITUTES`** **`CHANGE_ORDERS`** **`CHANGE_ORDER_APPROVALS`** **`CHANGE_ORDER_APPROVAL_REQUESTS`** **`CHANGE_ORDER_APPROVAL_ROLES`** **`CHARGE_ACCOUNTS`** **`COMMENTS`** **`CONTACTS`** **`CURRENCIES`** **`DATAGRID_COLUMNS`** **`DATAGRID_ROWS`** **`DATAGRID_VALUES`** **`ENTITIES`** **`ENTITIES_ASSETS`** **`ENTITIES_FILE_ATTACHMENTS`** **`ENTITIES_LABELS`** **`ENTITIES_REQUIREMENTS`** **`FILE_ATTACHMENTS`** **`FURTHER_ACTIONS`** **`FURTHER_ACTIONS_ATTRIBUTED_PARTS`** **`FURTHER_ACTIONS_ATTRIBUTED_USERS`** **`FURTHER_ACTIONS_ATTRIBUTES`** **`FURTHER_ACTION_APPROVALS`** **`FURTHER_ACTION_APPROVAL_REQUESTS`** **`FURTHER_ACTION_APPROVAL_ROLES`** **`FURTHER_ACTION_ISSUES`** **`FURTHER_ACTION_PARTS`** **`FURTHER_ACTION_RUNS`** **`IMPORT_JOBS`** **`INTENT_OPTIONS`** **`INVITES`** **`ISSUES`** **`ISSUES_ATTRIBUTED_PARTS`** **`ISSUES_ATTRIBUTED_USERS`** **`ISSUES_ATTRIBUTES`** **`ISSUE_APPROVALS`** **`ISSUE_APPROVAL_REQUESTS`** **`ISSUE_DISPOSITION_TYPES`** **`ISSUE_DISPOSITION_TYPE_ROLES`** **`ISSUE_PART_INVENTORIES`** **`ISSUE_RELATIONS`** **`LABELS`** **`LOCATIONS`** **`LOCATIONS_ATTRIBUTED_PARTS`** **`LOCATIONS_ATTRIBUTED_USERS`** **`LOCATIONS_ATTRIBUTES`** **`LOCATION_SUBTYPES`** **`MBOMS`** **`MBOMS_ATTRIBUTED_PARTS`** **`MBOMS_ATTRIBUTED_USERS`** **`MBOMS_ATTRIBUTES`** **`MBOM_APPROVALS`** **`MBOM_APPROVAL_REQUESTS`** **`MBOM_APPROVAL_ROLES`** **`MBOM_CHANGE_ORDER_LINES`** **`MBOM_CHANGE_ORDER_LINE_DIFFS`** **`MBOM_ITEM`** **`MBOM_ITEM_REFERENCE_DESIGNATORS`** **`MBOM_SUBSTITUTE`** **`MRP_JOBS`** **`OAUTH_APP_REGISTRATIONS`** **`OAUTH_REDIRECT_URIS`** **`ORGANIZATIONS`** **`ORGANIZATION_DOMAINS`** **`ORG_ATTRIBUTES`** **`ORIGIN_RUNS`** **`PARTS`** **`PARTS_ATTRIBUTED_PARTS`** **`PARTS_ATTRIBUTED_USERS`** **`PARTS_INVENTORIES_ATTRIBUTES`** **`PARTS_INVENTORY`** **`PARTS_INVENTORY_ROLLED_UP_COSTS`** **`PARTS_KITS`** **`PART_ATTRIBUTES`** **`PART_INVENTORIES_ATTRIBUTED_PARTS`** **`PART_INVENTORIES_ATTRIBUTED_USERS`** **`PART_INVENTORY_BUILD_REQUIREMENTS`** **`PART_KITS_ATTRIBUTED_PARTS`** **`PART_KITS_ATTRIBUTED_USERS`** **`PART_KIT_ATTRIBUTES`** **`PART_KIT_INVENTORIES`** **`PART_KIT_ITEMS`** **`PART_KIT_ITEMS_ATTRIBUTED_PARTS`** **`PART_KIT_ITEMS_ATTRIBUTED_USERS`** **`PART_KIT_ITEM_ATTRIBUTES`** **`PART_PART_SUBTYPES`** **`PART_PROCEDURES`** **`PART_SUBTYPES`** **`PERMISSION_GROUPS`** **`PERMISSION_GROUP_ROLES`** **`PICK_OVERRIDE_EVENTS`** **`PICK_RUNS`** **`PICK_RUN_KITS`** **`PICK_RUN_STOPS`** **`PICK_RUN_STOP_ALLOCATIONS`** **`PLANS`** **`PLANS_ATTRIBUTED_PARTS`** **`PLANS_ATTRIBUTED_USERS`** **`PLANS_ATTRIBUTES`** **`PLAN_CONSTRAINTS`** **`PLAN_CONSTRAINT_LOCATIONS`** **`PLAN_INPUTS`** **`PLAN_ITEMS`** **`PLAN_ITEM_ALLOCATIONS`** **`PLAN_ITEM_RESULTS`** **`PLAN_PLAN_ITEMS`** **`PLAN_RESERVATIONS`** **`PROCEDURES`** **`PROCEDURES_ATTRIBUTED_PARTS`** **`PROCEDURES_ATTRIBUTED_USERS`** **`PROCEDURES_ATTRIBUTES`** **`PROCEDURE_APPROVALS`** **`PROCEDURE_APPROVAL_REQUESTS`** **`PROCEDURE_APPROVAL_ROLES`** **`PROCEDURE_FAMILY_LABELS`** **`PROJECTS`** **`PURCHASE_ORDERS`** **`PURCHASE_ORDERS_ATTRIBUTED_PARTS`** **`PURCHASE_ORDERS_ATTRIBUTED_USERS`** **`PURCHASE_ORDERS_ATTRIBUTES`** **`PURCHASE_ORDER_APPROVALS`** **`PURCHASE_ORDER_APPROVAL_LEVELS`** **`PURCHASE_ORDER_APPROVAL_REQUESTS`** **`PURCHASE_ORDER_FEES`** **`PURCHASE_ORDER_LINES`** **`PURCHASE_ORDER_LINES_ATTRIBUTED_PARTS`** **`PURCHASE_ORDER_LINES_ATTRIBUTED_USERS`** **`PURCHASE_ORDER_LINES_ATTRIBUTES`** **`PURCHASE_ORDER_LINE_INVENTORIES`** **`RECEIPTS`** **`RECEIPTS_ATTRIBUTED_PARTS`** **`RECEIPTS_ATTRIBUTED_USERS`** **`RECEIPTS_ATTRIBUTES`** **`RECEIPT_ITEMS`** **`REDLINES`** **`REDLINE_APPROVALS`** **`REDLINE_APPROVAL_REQUESTS`** **`REDLINE_APPROVAL_ROLES`** **`REDLINE_ROLE_BASED_APPROVALS`** **`REDLINE_ROLE_BASED_APPROVAL_REQUESTS`** **`REFERENCE_DESIGNATOR_ASSIGNMENTS`** **`REQUIREMENTS`** **`REVIEWS`** **`REVIEW_REQUESTS`** **`ROLES`** **`RULES`** **`RUNS`** **`RUNS_ATTRIBUTED_PARTS`** **`RUNS_ATTRIBUTED_USERS`** **`RUNS_ATTRIBUTES`** **`RUN_BATCHES`** **`RUN_STEPS`** **`RUN_STEPS_ATTRIBUTED_PARTS`** **`RUN_STEPS_ATTRIBUTED_USERS`** **`RUN_STEPS_ATTRIBUTES`** **`RUN_STEPS_DAGS`** **`RUN_STEPS_FIELDS`** **`RUN_STEPS_STATUS_COUNTS`** **`RUN_STEP_BUILD_REQUIREMENT_SUBSTITUTES`** **`RUN_STEP_FIELD_VALIDATIONS`** **`RUN_STEP_PART_INVENTORIES`** **`RUN_STEP_RUNS`** **`RUN_STEP_SESSIONS`** **`SESSION_EVENTS`** **`SNAPSHOT_EXPORT_JOBS`** **`STEPS`** **`STEPS_ATTRIBUTED_PARTS`** **`STEPS_ATTRIBUTED_USERS`** **`STEPS_ATTRIBUTES`** **`STEPS_DAGS`** **`STEPS_FIELDS`** **`STEP_APPROVALS`** **`STEP_APPROVAL_REQUESTS`** **`STEP_APPROVAL_ROLES`** **`STEP_FIELD_VALIDATIONS`** **`STEP_PART_REQUIREMENTS`** **`STEP_PROPOSALS`** **`STEP_ROLE_BASED_APPROVALS`** **`STEP_ROLE_BASED_APPROVAL_REQUESTS`** **`SUPPLIERS`** **`SUPPLIERS_ATTRIBUTED_PARTS`** **`SUPPLIERS_ATTRIBUTED_USERS`** **`SUPPLIERS_ATTRIBUTES`** **`SUPPLIER_PARTS`** **`TEAMS`** **`TEAM_ROLES`** **`TEAM_USERS`** **`UNITS_OF_MEASUREMENTS`** **`USERS`** **`USER_DEFINED_MESSAGES`** **`USER_NOTIFICATIONS`** **`USER_ROLES`** **`USER_SUBSCRIPTIONS`** **`VALIDATION_FUNCTIONS`** **`WEBHOOK_EVENTS`** **`WEBHOOK_HEADERS`** **`WEBHOOK_RECEIVERS`** **`WEBHOOK_RECEIVER_HEADERS`** **`WEBHOOK_SUBSCRIPTIONS`** # TableNameEnumFilter Source: https://docs.firstresonance.io/api-reference/types/TableNameEnumFilter **Kind**: `input` ## Fields **`eq`**: `TableNameEnum` --- **`gt`**: `TableNameEnum` --- **`gte`**: `TableNameEnum` --- **`ilike`**: `TableNameEnum` --- **`in`**: `[TableNameEnum]` --- **`isnull`**: `Boolean` --- **`like`**: `TableNameEnum` --- **`lt`**: `TableNameEnum` --- **`lte`**: `TableNameEnum` --- **`neq`**: `TableNameEnum` --- **`notilike`**: `TableNameEnum` --- **`notlike`**: `TableNameEnum` # Team Source: https://docs.firstresonance.io/api-reference/types/Team A specific Group within an organization in Ion. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_RolesCount`**: `Int` Optimized count of roles. --- **`_TeamRolesCount`**: `Int` Optimized count of teamRoles. --- **`_TeamUsersCount`**: `Int` Optimized count of teamUsers. --- **`_UsersCount`**: `Int` Optimized count of users. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`deactivated`**: `Boolean` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` --- **`supervisor`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`supervisorId`**: `Int` --- **`teamRoles`**: `[TeamRole]` **Arguments:** - `filters`: `TeamRolesInputFilters` --- **`teamUsers`**: `[TeamUser]` **Arguments:** - `filters`: `TeamUsersInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `TeamEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`users`**: `[User]` **Arguments:** - `filters`: `UserInputFilters` # TeamEventFilter Source: https://docs.firstresonance.io/api-reference/types/TeamEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`deactivated`**: `BooleanFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`supervisorId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # TeamEvents Source: https://docs.firstresonance.io/api-reference/types/TeamEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `Team` --- **`oldValues`**: `Team` --- **`timestamp`**: `DateTime` # TeamRole Source: https://docs.firstresonance.io/api-reference/types/TeamRole A Role specific to a Team. **Kind**: `object` ## Fields **`Updated`**: `DateTime` --- **`_created`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`roleId`**: `Int` --- **`team`**: `Team` **Arguments:** - `filters`: `TeamsInputFilters` --- **`teamId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `TeamRoleEventFilter` # TeamRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/TeamRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`teamId`**: `IDFilter` # TeamRoleEvents Source: https://docs.firstresonance.io/api-reference/types/TeamRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `TeamRole` --- **`oldValues`**: `TeamRole` --- **`timestamp`**: `DateTime` # TeamRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/TeamRolesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[TeamRolesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`or_`**: `[TeamRolesInputFilters]` --- **`roleId`**: `IDFilter` --- **`team`**: `TeamsInputFilters` --- **`teamId`**: `IDFilter` # TeamSortEnum Source: https://docs.firstresonance.io/api-reference/types/TeamSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DEACTIVATED_ASC`** **`DEACTIVATED_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`SUPERVISOR_ID_ASC`** **`SUPERVISOR_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # TeamToRoleInput Source: https://docs.firstresonance.io/api-reference/types/TeamToRoleInput Inputs needed to relate a Role to a Team. **Kind**: `input` ## Fields **`roleId`**: `Int!` (required) --- **`teamId`**: `Int!` (required) # TeamToUserInput Source: https://docs.firstresonance.io/api-reference/types/TeamToUserInput Inputs needed to relate a User to a Team. **Kind**: `input` ## Fields **`teamId`**: `Int!` (required) --- **`userId`**: `Int!` (required) # TeamUser Source: https://docs.firstresonance.io/api-reference/types/TeamUser User related to a specific Team. **Kind**: `object` ## Fields **`Updated`**: `DateTime` --- **`_created`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`team`**: `Team` **Arguments:** - `filters`: `TeamsInputFilters` --- **`teamId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `TeamUserEventFilter` --- **`userId`**: `Int` # TeamUserEventFilter Source: https://docs.firstresonance.io/api-reference/types/TeamUserEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`teamId`**: `IDFilter` --- **`userId`**: `IDFilter` # TeamUserEvents Source: https://docs.firstresonance.io/api-reference/types/TeamUserEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `TeamUser` --- **`oldValues`**: `TeamUser` --- **`timestamp`**: `DateTime` # TeamUsersInputFilters Source: https://docs.firstresonance.io/api-reference/types/TeamUsersInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[TeamUsersInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`or_`**: `[TeamUsersInputFilters]` --- **`team`**: `TeamsInputFilters` --- **`teamId`**: `IDFilter` --- **`userId`**: `IDFilter` # TeamsConnection Source: https://docs.firstresonance.io/api-reference/types/TeamsConnection **Kind**: `object` ## Fields **`edges`**: `[TeamsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # TeamsEdge Source: https://docs.firstresonance.io/api-reference/types/TeamsEdge A Relay edge containing a `Teams` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `Team` The item at the end of the edge # TeamsInputFilters Source: https://docs.firstresonance.io/api-reference/types/TeamsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[TeamsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`deactivated`**: `BooleanFilter` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[TeamsInputFilters]` --- **`supervisor`**: `UserInputFilters` --- **`supervisorId`**: `IDFilter` --- **`teamRoles`**: `TeamRolesInputFilters` --- **`teamUsers`**: `TeamUsersInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`users`**: `UserInputFilters` # Timeline Source: https://docs.firstresonance.io/api-reference/types/Timeline Interface defining common fields and functions for timeline events. Deprecated: Use `LoggedAction` instead. **Kind**: `interface` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`timestamp`**: `DateTime` ## Possible types - `ABomInstallationEvents` - `ApprovalLevelEvents` - `BarcodeLabelEvents` - `BarcodePatternEvents` - `BarcodePrintRequestEvents` - `BarcodeScanRequestEvents` - `BarcodeTemplateEvents` - `BuildRequirementEvents` - `BuildRequirementReferenceDesignatorEvents` - `BuildRequirementSubstituteEvents` - `ChangeOrderApprovalEvents` - `ChangeOrderApprovalRequestEvents` - `ChangeOrderApprovalRoleEvents` - `ChangeOrderEvents` - `CommentEvents` - `ContactEvents` - `CurrencyEvents` - `DatagridColumnEvents` - `DatagridRowEvents` - `DatagridValueEvents` - `EntitiesRequirementEvents` - `EntityEvents` - `FileAttachmentEvents` - `FurtherActionApprovalEvents` - `FurtherActionApprovalRequestEvents` - `FurtherActionApprovalRoleEvents` - `FurtherActionAttributeEvents` - `FurtherActionEvents` - `FurtherActionIssueEvents` - `FurtherActionPartEvents` - `FurtherActionRunEvents` - `ImportJobEvents` - `IntentOptionEvents` - `InviteEvents` - `IssueApprovalEvents` - `IssueApprovalRequestEvents` - `IssueAttributeEvents` - `IssueDispositionTypeEvents` - `IssueDispositionTypeRoleEvents` - `IssueEvents` - `IssuePartInventoryEvents` - `IssueRelationEvents` - `LabelEvents` - `LocationAttributeEvents` - `LocationEvents` - `LocationSubtypeEvents` - `MBomApprovalEvents` - `MBomApprovalRequestEvents` - `MBomApprovalRoleEvents` - `MBomEvents` - `MBomItemEvents` - `MBomItemReferenceDesignatorEvents` - `MBomSubstituteEvents` - `MRPJobEvents` - `MbomAttributeEvents` - `MbomChangeOrderLineDiffEvents` - `MbomChangeOrderLineEvents` - `OrganizationDomainEvents` - `PartAttributeEvents` - `PartEvents` - `PartInventoryAttributeEvents` - `PartInventoryBuildRequirementEvents` - `PartInventoryEvents` - `PartInventoryHistoryActionEvents` - `PartKitAttributeEvents` - `PartKitEvents` - `PartKitItemAttributeEvents` - `PartKitItemEvents` - `PartProcedureEvents` - `PartSubtypeEvents` - `PartUnitOfMeasureConflictEvents` - `PermissionGroupEvents` - `PickOverrideEventEvents` - `PickRunEvents` - `PickRunStopAllocationEvents` - `PickRunStopEvents` - `PlanAttributeEvents` - `PlanConstraintEvents` - `PlanConstraintLocationEvents` - `PlanEvents` - `PlanInputEvents` - `PlanItemAllocationEvents` - `PlanItemEvents` - `PlanReservationEvents` - `ProcedureApprovalEvents` - `ProcedureApprovalRequestEvents` - `ProcedureApprovalRoleEvents` - `ProcedureAttributeEvents` - `ProcedureEvents` - `ProcedureFamilyLabelEvents` - `PurchaseOrderApprovalEvents` - `PurchaseOrderApprovalLevelEvents` - `PurchaseOrderApprovalRequestEvents` - `PurchaseOrderAttributeEvents` - `PurchaseOrderEvents` - `PurchaseOrderFeeEvents` - `PurchaseOrderLineAttributeEvents` - `PurchaseOrderLineEvents` - `PurchaseOrderLineInventoryEvents` - `ReceiptAttributeEvents` - `ReceiptEvents` - `ReceiptItemEvents` - `RecommendationEvents` - `RedlineApprovalEvents` - `RedlineApprovalRequestEvents` - `RedlineApprovalRoleEvents` - `RedlineEvents` - `RedlineRoleBasedApprovalEvents` - `RedlineRoleBasedApprovalRequestEvents` - `RequirementEvents` - `ReviewEvents` - `ReviewRequestEvents` - `RoleEvents` - `RuleEvents` - `RunAttributeEvents` - `RunBatchEvents` - `RunEvents` - `RunStepAttributeEvents` - `RunStepBuildRequirementSubstituteEvents` - `RunStepEvents` - `RunStepFieldEvents` - `RunStepFieldValidationEvents` - `RunStepsEdgeEvents` - `SessionEvents` - `SnapshotExportJobEvents` - `StepApprovalEvents` - `StepApprovalRequestEvents` - `StepApprovalRoleEvents` - `StepAttributeEvents` - `StepEvents` - `StepFieldEvents` - `StepFieldValidationEvents` - `StepProposalEvents` - `StepRoleBasedApprovalEvents` - `StepRoleBasedApprovalRequestEvents` - `StepsEdgeEvents` - `SupplierAttributeEvents` - `SupplierEvents` - `SupplierPartEvents` - `TeamEvents` - `TeamRoleEvents` - `TeamUserEvents` - `UnitOfMeasurementEvents` - `UserDefinedMessageEvents` - `UserEvents` - `UserNotificationEvents` - `UserRoleEvents` - `UserSubscriptionEvents` - `ValidationFunctionEvents` - `WebhookEventEvents` - `WebhookHeaderEvents` - `WebhookReceiverEvents` - `WebhookSubscriptionEvents` # ToolConnection Source: https://docs.firstresonance.io/api-reference/types/ToolConnection **Kind**: `object` ## Fields **`edges`**: `[ToolEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `PageInfo!` Pagination data for this connection. # ToolEdge Source: https://docs.firstresonance.io/api-reference/types/ToolEdge A Relay edge containing a `Tool` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `PartInventory` The item at the end of the edge # Trackingtypeenum Source: https://docs.firstresonance.io/api-reference/types/Trackingtypeenum **Kind**: `enum` ## Values **`LOT`** **`SERIAL`** # TrackingtypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/TrackingtypeenumFilter **Kind**: `input` ## Fields **`eq`**: `Trackingtypeenum` --- **`gt`**: `Trackingtypeenum` --- **`gte`**: `Trackingtypeenum` --- **`ilike`**: `Trackingtypeenum` --- **`in`**: `[Trackingtypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Trackingtypeenum` --- **`lt`**: `Trackingtypeenum` --- **`lte`**: `Trackingtypeenum` --- **`neq`**: `Trackingtypeenum` --- **`notilike`**: `Trackingtypeenum` --- **`notlike`**: `Trackingtypeenum` # UUID Source: https://docs.firstresonance.io/api-reference/types/UUID Leverages the internal Python implmeentation of UUID (uuid.UUID) to provide native UUID objects in fields, resolvers and input. **Kind**: `scalar` # UUIDFilter Source: https://docs.firstresonance.io/api-reference/types/UUIDFilter **Kind**: `input` ## Fields **`eq`**: `UUID` --- **`gt`**: `UUID` --- **`gte`**: `UUID` --- **`ilike`**: `UUID` --- **`in`**: `[UUID]` --- **`isnull`**: `Boolean` --- **`like`**: `UUID` --- **`lt`**: `UUID` --- **`lte`**: `UUID` --- **`neq`**: `UUID` --- **`notilike`**: `UUID` --- **`notlike`**: `UUID` # UnassignReferenceDesignatorFromRunStep Source: https://docs.firstresonance.io/api-reference/types/UnassignReferenceDesignatorFromRunStep Unassign a reference designator from a run step (redline-gated). **Kind**: `object` ## Fields **`buildRequirementReferenceDesignatorId`**: `Int` # UnassignReferenceDesignatorFromRunStepInput Source: https://docs.firstresonance.io/api-reference/types/UnassignReferenceDesignatorFromRunStepInput Unassign a reference designator from a run step. **Kind**: `input` ## Fields **`buildRequirementReferenceDesignatorId`**: `Int!` (required) --- **`etag`**: `String!` (required) --- **`runStepId`**: `Int!` (required) # UnbatchRunSteps Source: https://docs.firstresonance.io/api-reference/types/UnbatchRunSteps Mutation to manually unbatch a run step. **Kind**: `object` ## Fields **`runSteps`**: `[RunStep]` # UnbatchRunStepsInput Source: https://docs.firstresonance.io/api-reference/types/UnbatchRunStepsInput Inputs needed manually unbatch a run step. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) # UnconfirmMbomChangeOrderLineDiffResolution Source: https://docs.firstresonance.io/api-reference/types/UnconfirmMbomChangeOrderLineDiffResolution Take back the sign-off; each row keeps the resolution it shows. **Kind**: `object` ## Fields **`diffs`**: `[MbomChangeOrderLineDiff]` # UnconfirmMbomChangeOrderLineDiffResolutionInput Source: https://docs.firstresonance.io/api-reference/types/UnconfirmMbomChangeOrderLineDiffResolutionInput Input to take the sign-off back off one or many diffs. **Kind**: `input` ## Fields **`confirmMatchingDiffs`**: `Boolean` --- **`sources`**: `[MbomChangeOrderLineDiffSourceInput]!` (required) # UndoStepProposal Source: https://docs.firstresonance.io/api-reference/types/UndoStepProposal Restores what an accepted proposal overwrote and returns it to live. **Kind**: `object` ## Fields **`step`**: `Step` --- **`stepProposal`**: `StepProposal` # UnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/types/UnitOfMeasurement A custom unit of measurement to use throughout the Ion Platform. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int` User id of creator related to Enum. Returns: int of id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UnitOfMeasurementEventFilter` --- **`type`**: `String!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int` User id of updater related to Enum. Returns: int of id # UnitOfMeasurementEventFilter Source: https://docs.firstresonance.io/api-reference/types/UnitOfMeasurementEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`type`**: `StringFilter` --- **`updatedById`**: `IDFilter` # UnitOfMeasurementEvents Source: https://docs.firstresonance.io/api-reference/types/UnitOfMeasurementEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `UnitOfMeasurement` --- **`oldValues`**: `UnitOfMeasurement` --- **`timestamp`**: `DateTime` # UnitOfMeasurementSortEnum Source: https://docs.firstresonance.io/api-reference/types/UnitOfMeasurementSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # UnitOfMeasurementsConnection Source: https://docs.firstresonance.io/api-reference/types/UnitOfMeasurementsConnection **Kind**: `object` ## Fields **`edges`**: `[UnitOfMeasurementsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # UnitOfMeasurementsEdge Source: https://docs.firstresonance.io/api-reference/types/UnitOfMeasurementsEdge A Relay edge containing a `UnitOfMeasurements` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `UnitOfMeasurement` The item at the end of the edge # UnitsOfMeasurementInputFilters Source: https://docs.firstresonance.io/api-reference/types/UnitsOfMeasurementInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[UnitsOfMeasurementInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[UnitsOfMeasurementInputFilters]` --- **`type`**: `StringFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # UnlinkRunStepFromPurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/UnlinkRunStepFromPurchaseOrder Unlink an OSP run step from its purchase order line without deleting the PO line. Removes only the purchase_order_line_inventories record for this run step. The PO line itself is preserved along with any other runs' inventories on it. Errors: rejected with a ValidationError when the primary OR any sibling that this call would touch has been received — either the parent PO line's status is ``RECEIVED``, or the specific part inventory has already been recorded against a receipt for its current line (the line stays ``ORDERED`` for serial-tracked lines with multiple POLIs until every POLI is received, but each individually received POLI is locked from that moment on). Received POLIs are part of the receipt audit trail and cannot be unlinked. ``applyToAllRunStepsInBatch`` controls batch propagation: when ``true`` (the default) and the run step is part of a normalized batch, every batch sibling currently linked to a PO line is also unlinked. Set to ``false`` to unlink only the specified run step. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` # UnlinkRunStepFromPurchaseOrderInput Source: https://docs.firstresonance.io/api-reference/types/UnlinkRunStepFromPurchaseOrderInput Input for unlinking a run step from its purchase order line (POLI only). When the run step is part of a normalized batch and ``applyToAllRunStepsInBatch`` is ``true`` (the default), every batch sibling that currently has a POLI will also be unlinked. Set to ``false`` to unlink only the specified run step. **Kind**: `input` ## Fields **`applyToAllRunStepsInBatch`**: `Boolean` = true When true (the default) and the run step belongs to a normalized batch, every batch sibling that currently has a POLI is also unlinked, regardless of which PO line it sits on. When false, only the specified run step is unlinked. If the field is omitted or sent as null, the default (true) applies. --- **`runStepId`**: `Int!` (required) # UpdateABomInstallation Source: https://docs.firstresonance.io/api-reference/types/UpdateABomInstallation Update a ABomInstallation given an UpdateABomInstallationInput. **Kind**: `object` ## Fields **`abomInstallation`**: `ABomInstallation` --- **`splitInventory`**: `PartInventory` # UpdateABomInstallationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateABomInstallationInput Inputs needed to update an ABomInstallation. **Kind**: `input` ## Fields **`actingParentPartInventoryId`**: `Int` --- **`buildRequirementId`**: `Int!` (required) --- **`buildRequirementReferenceDesignatorId`**: `Int` --- **`etag`**: `String!` (required) --- **`partInventoryId`**: `Int!` (required) --- **`quantity`**: `Float` --- **`runStepId`**: `Int` # UpdateAPIKey Source: https://docs.firstresonance.io/api-reference/types/UpdateAPIKey Updates API Credential sets. **Kind**: `object` ## Fields **`apikey`**: `APIKeyObject` # UpdateApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/UpdateApprovalLevel **Kind**: `object` ## Fields **`approvalLevel`**: `ApprovalLevel` # UpdateApprovalLevelInput Source: https://docs.firstresonance.io/api-reference/types/UpdateApprovalLevelInput Inputs needed to update object. **Kind**: `input` ## Fields **`costThreshold`**: `Float` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`isTeamSelectedLater`**: `Boolean` --- **`ordinalPosition`**: `Int` --- **`roleId`**: `Int` --- **`teamId`**: `Int` # UpdateAttributeSettingsInput Source: https://docs.firstresonance.io/api-reference/types/UpdateAttributeSettingsInput Inputs to update or insert part attribute in org settings. **Kind**: `input` ## Fields **`allowedIonType`**: `organizationiontypeentitytypeenum` --- **`archived`**: `Boolean` --- **`archivedOptions`**: `[String]` --- **`criticality`**: `extensibleattributecriticalityenum` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`key`**: `String!` (required) --- **`options`**: `[String]` --- **`type`**: `attribute_typesattrtypesenum` # UpdateBarcodeLabel Source: https://docs.firstresonance.io/api-reference/types/UpdateBarcodeLabel **Kind**: `object` ## Fields **`barcodeLabel`**: `BarcodeLabel` # UpdateBarcodeLabelInput Source: https://docs.firstresonance.io/api-reference/types/UpdateBarcodeLabelInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`labelPreviewId`**: `ID` # UpdateBarcodePattern Source: https://docs.firstresonance.io/api-reference/types/UpdateBarcodePattern **Kind**: `object` ## Fields **`barcodePattern`**: `BarcodePattern` # UpdateBarcodePatternInput Source: https://docs.firstresonance.io/api-reference/types/UpdateBarcodePatternInput **Kind**: `input` ## Fields **`barcodePatternJson`**: `JSONString` --- **`entityType`**: `Barcodeentitytypeenum` --- **`etag`**: `String!` (required) --- **`expression`**: `String` --- **`id`**: `ID!` (required) # UpdateBarcodeTemplate Source: https://docs.firstresonance.io/api-reference/types/UpdateBarcodeTemplate **Kind**: `object` ## Fields **`barcodeTemplate`**: `BarcodeTemplate` # UpdateBarcodeTemplateInput Source: https://docs.firstresonance.io/api-reference/types/UpdateBarcodeTemplateInput **Kind**: `input` ## Fields **`deactivated`**: `Boolean` --- **`dpi`**: `Int` --- **`etag`**: `String!` (required) --- **`format`**: `Barcodeformatenum` --- **`heightInches`**: `Float` --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`template`**: `String` --- **`widthInches`**: `Float` # UpdateBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/UpdateBuildRequirement **Kind**: `object` ## Fields **`buildRequirement`**: `BuildRequirement` # UpdateBuildRequirementInput Source: https://docs.firstresonance.io/api-reference/types/UpdateBuildRequirementInput Inputs needed to update a BuildRequirement. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`madeOnAssembly`**: `Boolean` --- **`quantityPerParentPartInventory`**: `Float` # UpdateBuildRequirementReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/UpdateBuildRequirementReferenceDesignator **Kind**: `object` ## Fields **`buildRequirementReferenceDesignator`**: `BuildRequirementReferenceDesignator` # UpdateBuildRequirementReferenceDesignatorInput Source: https://docs.firstresonance.io/api-reference/types/UpdateBuildRequirementReferenceDesignatorInput Inputs needed to update a BuildRequirementReferenceDesignator. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`value`**: `String!` (required) # UpdateBuildRequirementSubstitute Source: https://docs.firstresonance.io/api-reference/types/UpdateBuildRequirementSubstitute **Kind**: `object` ## Fields **`buildRequirementSubstitute`**: `BuildRequirementSubstitute` # UpdateBuildRequirementSubstituteInput Source: https://docs.firstresonance.io/api-reference/types/UpdateBuildRequirementSubstituteInput Inputs needed to update a BuildRequirementSubstitute. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`partId`**: `Int!` (required) # UpdateChangeOrder Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrder **Kind**: `object` ## Fields **`changeOrder`**: `ChangeOrder` # UpdateChangeOrderApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderApproval **Kind**: `object` ## Fields **`approval`**: `ChangeOrderApproval` # UpdateChangeOrderApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderApprovalInput Inputs needed to update a change order approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`gateType`**: `Changeorderapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateChangeOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `ChangeOrderApprovalRequest` # UpdateChangeOrderApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderApprovalRequestInput Inputs needed to update a change order approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`gateType`**: `Changeorderapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateChangeOrderApprovalRole Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `ChangeOrderApprovalRole` # UpdateChangeOrderApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderApprovalRoleInput Input needed to update change order approval roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`gateType`**: `Changeorderapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # UpdateChangeOrderInput Source: https://docs.firstresonance.io/api-reference/types/UpdateChangeOrderInput Inputs needed to update a change order's fields. Each status transition has its own mutation and permission group. **Kind**: `input` ## Fields **`description`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`title`**: `String` # UpdateChargeAccount Source: https://docs.firstresonance.io/api-reference/types/UpdateChargeAccount **Kind**: `object` ## Fields **`chargeAccount`**: `ChargeAccount` # UpdateChargeAccountInput Source: https://docs.firstresonance.io/api-reference/types/UpdateChargeAccountInput Inputs needed to update a charge account. **Kind**: `input` ## Fields **`archived`**: `Boolean` --- **`code`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`title`**: `String` # UpdateComment Source: https://docs.firstresonance.io/api-reference/types/UpdateComment **Kind**: `object` ## Fields **`comment`**: `Comment` # UpdateCommentInput Source: https://docs.firstresonance.io/api-reference/types/UpdateCommentInput **Kind**: `input` ## Fields **`content`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`procedureFeedback`**: `Boolean` --- **`resolved`**: `Boolean` --- **`slateContent`**: `SlateContent` # UpdateContact Source: https://docs.firstresonance.io/api-reference/types/UpdateContact **Kind**: `object` ## Fields **`contact`**: `Contact` # UpdateContactInput Source: https://docs.firstresonance.io/api-reference/types/UpdateContactInput **Kind**: `input` ## Fields **`email`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`phoneNumber`**: `String` # UpdateCurrency Source: https://docs.firstresonance.io/api-reference/types/UpdateCurrency **Kind**: `object` ## Fields **`currency`**: `Currency` # UpdateCurrencyInput Source: https://docs.firstresonance.io/api-reference/types/UpdateCurrencyInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`type`**: `String` # UpdateDatagridColumn Source: https://docs.firstresonance.io/api-reference/types/UpdateDatagridColumn **Kind**: `object` ## Fields **`datagridColumn`**: `DatagridColumn` # UpdateDatagridColumnInput Source: https://docs.firstresonance.io/api-reference/types/UpdateDatagridColumnInput **Kind**: `input` ## Fields **`Settable`**: `Boolean` --- **`allowedIonType`**: `datagridiontypeentitytypeenum` --- **`etag`**: `String!` (required) --- **`header`**: `String` --- **`id`**: `ID!` (required) --- **`options`**: `[String]` --- **`settable`**: `Boolean` --- **`signoffRoleId`**: `ID` --- **`type`**: `datagrid_typefieldtypes` --- **`unit`**: `String` # UpdateDatagridRow Source: https://docs.firstresonance.io/api-reference/types/UpdateDatagridRow **Kind**: `object` ## Fields **`datagridRow`**: `DatagridRow` # UpdateDatagridRowInput Source: https://docs.firstresonance.io/api-reference/types/UpdateDatagridRowInput **Kind**: `input` ## Fields **`allowNotApplicable`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`required`**: `Boolean` # UpdateFieldPositionInput Source: https://docs.firstresonance.io/api-reference/types/UpdateFieldPositionInput Inputs needed to update FieldPosition. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`position`**: `Int!` (required) # UpdateFurtherAction Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherAction **Kind**: `object` ## Fields **`furtherAction`**: `FurtherAction` # UpdateFurtherActionApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionApproval **Kind**: `object` ## Fields **`approval`**: `FurtherActionApproval` # UpdateFurtherActionApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionApprovalInput Inputs needed to update FurtherAction approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateFurtherActionApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `FurtherActionApprovalRequest` # UpdateFurtherActionApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionApprovalRequestInput Inputs needed to update FurtherAction approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateFurtherActionApprovalRole Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `FurtherActionApprovalRole` # UpdateFurtherActionApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionApprovalRoleInput Input needed to delete update approval roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`gateType`**: `Furtheractionapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # UpdateFurtherActionInput Source: https://docs.firstresonance.io/api-reference/types/UpdateFurtherActionInput Inputs needed to update a FurtherAction. **Kind**: `input` ## Fields **`analysisNotes`**: `SlateContent` --- **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`estimatedCompletionDate`**: `DateTime` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`problemStatement`**: `SlateContent` --- **`resolution`**: `SlateContent` --- **`status`**: `FurtherActionStatus` --- **`title`**: `String` # UpdateGlobalUniqueSerialNumberSchemeSettingInput Source: https://docs.firstresonance.io/api-reference/types/UpdateGlobalUniqueSerialNumberSchemeSettingInput Input to update part revision from organization settings. **Kind**: `input` ## Fields **`default`**: `Boolean` --- **`enabled`**: `Boolean` --- **`etag`**: `String!` (required) --- **`exclude`**: `String` --- **`id`**: `Int!` (required) --- **`name`**: `String!` (required) --- **`serialScheme`**: `String` --- **`startAt`**: `Int` # UpdateImportJob Source: https://docs.firstresonance.io/api-reference/types/UpdateImportJob **Kind**: `object` ## Fields **`importJob`**: `ImportJob` # UpdateImportJobInput Source: https://docs.firstresonance.io/api-reference/types/UpdateImportJobInput **Kind**: `input` ## Fields **`errors`**: `JSONString` --- **`etag`**: `String!` (required) --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`filename`**: `String` --- **`id`**: `ID!` (required) --- **`importDuration`**: `Int` --- **`importOptions`**: `JSONString` --- **`numRows`**: `Int` --- **`status`**: `ImportJobStatus` --- **`type`**: `Importjobtypeenum` # UpdateInputToPlan Source: https://docs.firstresonance.io/api-reference/types/UpdateInputToPlan **Kind**: `object` ## Fields **`planInput`**: `PlanInput` # UpdateInputToPlanInput Source: https://docs.firstresonance.io/api-reference/types/UpdateInputToPlanInput **Kind**: `input` ## Fields **`Deleted`**: `Boolean` --- **`completedQuantity`**: `Int` --- **`dueDate`**: `DateTime` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`isGenerateNewDemand`**: `Boolean` --- **`isIndependent`**: `Boolean` --- **`name`**: `String` --- **`partId`**: `ID` --- **`planId`**: `ID` --- **`quantity`**: `Int` --- **`serialNumber`**: `String` # UpdateIntentOption Source: https://docs.firstresonance.io/api-reference/types/UpdateIntentOption **Kind**: `object` ## Fields **`intentOption`**: `IntentOption` # UpdateIntentOptionInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIntentOptionInput Inputs needed to update an intent option. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`isReceivingInspectionRunRequired`**: `Boolean` --- **`rank`**: `Int` --- **`value`**: `String` # UpdateIssue Source: https://docs.firstresonance.io/api-reference/types/UpdateIssue **Kind**: `object` ## Fields **`issue`**: `Issue` # UpdateIssueApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueApproval **Kind**: `object` ## Fields **`approval`**: `IssueApproval` # UpdateIssueApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueApprovalInput Inputs needed to update issue approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateIssueApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `IssueApprovalRequest` # UpdateIssueApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueApprovalRequestInput Inputs needed to update issue approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`issueApprovalGateType`**: `gateTypeissueapprovalgatetypeenum` --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateIssueAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueAttribute **Kind**: `object` ## Fields **`issueAttribute`**: `IssueAttribute` # UpdateIssueAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`issueId`**: `Int!` (required) --- **`key`**: `String!` (required) --- **`value`**: `ScalarValue` # UpdateIssueAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueAttributes **Kind**: `object` ## Fields **`issueAttributes`**: `[IssueAttribute]` # UpdateIssueDispositionType Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueDispositionType **Kind**: `object` ## Fields **`issueDispositionType`**: `IssueDispositionType` # UpdateIssueDispositionTypeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueDispositionTypeInput Inputs needed to update issue disposition types. **Kind**: `input` ## Fields **`active`**: `Boolean` --- **`autoResolve`**: `Boolean` --- **`availabilityBehavior`**: `IssueDispositionTypeAvailabilityBehavior` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`intentOptionId`**: `Int` --- **`title`**: `String` # UpdateIssueDispositionTypeRole Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueDispositionTypeRole **Kind**: `object` ## Fields **`issueDispositionTypeRole`**: `IssueDispositionTypeRole` # UpdateIssueDispositionTypeRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueDispositionTypeRoleInput Inputs needed to update issue disposition type roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`issueApprovalGateType`**: `Issueapprovalgatetypeenum!` (required) --- **`issueDispositionTypeId`**: `Int!` (required) --- **`roleId`**: `Int!` (required) # UpdateIssueInput Source: https://docs.firstresonance.io/api-reference/types/UpdateIssueInput Inputs needed to update an Issue. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`causeCondition`**: `SlateContent` --- **`disposition`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`expectedCondition`**: `SlateContent` --- **`fixPartInventoryId`**: `Int` --- **`id`**: `ID!` (required) --- **`issueDispositionTypeId`**: `Int` --- **`mustCloseByRunStepId`**: `Int` --- **`purchaseOrderLineId`**: `Int` --- **`runStepId`**: `ID` --- **`status`**: `Issuestatusenum` --- **`title`**: `String` # UpdateLabel Source: https://docs.firstresonance.io/api-reference/types/UpdateLabel **Kind**: `object` ## Fields **`label`**: `Label` # UpdateLabelInput Source: https://docs.firstresonance.io/api-reference/types/UpdateLabelInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`value`**: `String!` (required) # UpdateLocation Source: https://docs.firstresonance.io/api-reference/types/UpdateLocation **Kind**: `object` ## Fields **`location`**: `Location` # UpdateLocationAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateLocationAttribute **Kind**: `object` ## Fields **`locationAttribute`**: `LocationAttribute` # UpdateLocationAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateLocationAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`locationId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateLocationAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateLocationAttributes **Kind**: `object` ## Fields **`locationAttributes`**: `[LocationAttribute]` # UpdateLocationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateLocationInput Inputs needed to update object. **Kind**: `input` ## Fields **`address`**: `String` --- **`archived`**: `Boolean` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`available`**: `Boolean` --- **`canHoldInventory`**: `Boolean` --- **`contactId`**: `Int` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`excludeFromMergePartInventory`**: `Boolean` Exclude the location from inventory merge (V2 merge only). --- **`id`**: `Int!` (required) --- **`imageId`**: `Int` --- **`latitude`**: `Float` --- **`locationSubtypeId`**: `Int` --- **`longitude`**: `Float` --- **`name`**: `String` --- **`parentId`**: `Int` --- **`pickSequence`**: `Int` Walk order for picking. Null falls back to name order. --- **`pickable`**: `Boolean` --- **`supervisorId`**: `Int` --- **`type`**: `Locationtypeenum` # UpdateLocationSubtype Source: https://docs.firstresonance.io/api-reference/types/UpdateLocationSubtype **Kind**: `object` ## Fields **`locationSubtype`**: `LocationSubtype` # UpdateLocationSubtypeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateLocationSubtypeInput **Kind**: `input` ## Fields **`description`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` # UpdateMBom Source: https://docs.firstresonance.io/api-reference/types/UpdateMBom **Kind**: `object` ## Fields **`mbom`**: `MBom` # UpdateMBomApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomApproval **Kind**: `object` ## Fields **`approval`**: `MBomApproval` # UpdateMBomApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomApprovalInput Inputs needed to update mBOM approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`gateType`**: `Mbomapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateMBomApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `MBomApprovalRequest` # UpdateMBomApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomApprovalRequestInput Inputs needed to update mBOM approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`gateType`**: `Mbomapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateMBomApprovalRole Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `MBomApprovalRole` # UpdateMBomApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomApprovalRoleInput Input needed to delete update approval roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`gateType`**: `Mbomapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # UpdateMBomInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomInput Inputs needed to update an mBOM. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`status`**: `MBomStatus` # UpdateMBomItem Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomItem **Kind**: `object` ## Fields **`mbomItem`**: `MBomItem` # UpdateMBomItemInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomItemInput Inputs needed to update an mBOM item. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`excludeFromKit`**: `Boolean` --- **`id`**: `ID!` (required) --- **`madeOnAssembly`**: `Boolean` --- **`partId`**: `ID` --- **`quantity`**: `Float` # UpdateMBomItemReferenceDesignator Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomItemReferenceDesignator **Kind**: `object` ## Fields **`mbomItemReferenceDesignator`**: `MBomItemReferenceDesignator` # UpdateMBomItemReferenceDesignatorInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMBomItemReferenceDesignatorInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`mbomItemId`**: `ID` --- **`value`**: `String` # UpdateMRPJob Source: https://docs.firstresonance.io/api-reference/types/UpdateMRPJob **Kind**: `object` ## Fields **`mrpJob`**: `MRPJob` # UpdateMRPJobInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMRPJobInput **Kind**: `input` ## Fields **`endTime`**: `DateTime` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`startTime`**: `DateTime` --- **`status`**: `Jobstatusenum` # UpdateMbomAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateMbomAttribute **Kind**: `object` ## Fields **`mbomAttribute`**: `MbomAttribute` # UpdateMbomAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMbomAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`mbomId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateMbomAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateMbomAttributes **Kind**: `object` ## Fields **`mbomAttributes`**: `[MbomAttribute]` # UpdateMultiplePartInventory Source: https://docs.firstresonance.io/api-reference/types/UpdateMultiplePartInventory Update multiple part inventories mutation. **Kind**: `object` ## Fields **`partInventory`**: `[PartInventory]` --- **`splitInventory`**: `[PartInventory]` # UpdateMultiplePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/UpdateMultiplePartInventoryInput Input for Updating Multiple Part Inventories. **Kind**: `input` ## Fields **`partInventory`**: `[UpdatePartInventoryInput]` # UpdateOAuthApp Source: https://docs.firstresonance.io/api-reference/types/UpdateOAuthApp Update an OAuth application registration (rename). **Kind**: `object` ## Fields **`oauthApp`**: `OAuthAppRegistrationObject` # UpdateOrganization Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganization Updates an Organization given a UpdateOrganizationInput argument. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationBranding Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationBranding Update branding (logo, colors) for the organization's Auth0 login page. **Kind**: `object` ## Fields **`branding`**: `OrganizationBrandingType` --- **`success`**: `Boolean` # UpdateOrganizationFurtherActionAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationFurtherActionAttributes Update or insert further action attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationGlobalUniqueSerialNumberScheme Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationGlobalUniqueSerialNumberScheme Update GlobalUniqueSerialNumber in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationInput Inputs needed to update an Organization. **Kind**: `input` ## Fields **`aiEnabled`**: `Boolean` Whether this org uses ION Intelligence. Admin-only: a non-admin changing it is rejected even with the UpdateOrganization permission. --- **`avatar`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`settings`**: `OrganizationSettingsInput` # UpdateOrganizationIssueAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationIssueAttributes Update or insert issue attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationLocationAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationLocationAttributes Update or insert location attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationMbomAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationMbomAttributes Update or insert mbom attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationMfaPolicy Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationMfaPolicy Enable or disable MFA requirement for the organization. **Kind**: `object` ## Fields **`success`**: `Boolean` # UpdateOrganizationPartAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPartAttributes Update or insert part attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPartInventoryAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPartInventoryAttributes Update or insert part inventory attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPartKitAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPartKitAttributes Update or insert part kit attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPartKitItemAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPartKitItemAttributes Update or insert part kit item attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPartRevisionScheme Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPartRevisionScheme Update part revision format in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPlanAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPlanAttributes Update or insert plan attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationProcedureAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationProcedureAttributes Update or insert Procedure attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPurchaseOrderAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPurchaseOrderAttributes Update or insert purchase order attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationPurchaseOrderLineAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationPurchaseOrderLineAttributes Update or insert purchase order line attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationReceiptAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationReceiptAttributes Update or insert receipt attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationRunAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationRunAttributes Update or insert run attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationRunStepAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationRunStepAttributes Add or update a run-step attribute in organization settings. Run-step and step attributes are the same attributes, so this updates the matching step attribute as well. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationStepAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationStepAttributes Add or update a step attribute in organization settings. Step and run-step attributes are the same attributes, so this updates the matching run-step attribute as well. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdateOrganizationSupplierAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateOrganizationSupplierAttributes Update or insert supplier attribute in organization settings. **Kind**: `object` ## Fields **`organization`**: `Organization` # UpdatePart Source: https://docs.firstresonance.io/api-reference/types/UpdatePart Update a part and its attributes. **Kind**: `object` ## Fields **`part`**: `Part` # UpdatePartAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePartAttribute **Kind**: `object` ## Fields **`partAttribute`**: `PartAttribute` # UpdatePartAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`partId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePartAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePartAttributes **Kind**: `object` ## Fields **`partAttributes`**: `[PartAttribute]` # UpdatePartInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartInput Input to create a part. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`cost`**: `Float` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`exportControlled`**: `Boolean` --- **`hasInventory`**: `Boolean` --- **`id`**: `ID!` (required) --- **`intentOptionId`**: `Int` --- **`leadTime`**: `Int` --- **`maintenanceIntervalSeconds`**: `Int` --- **`partNumber`**: `String` --- **`partType`**: `Parttypeenum` --- **`purchaseType`**: `purchasetypeenum` --- **`reorderMaximumQuantity`**: `Float` --- **`reorderMinimumQuantity`**: `Float` --- **`revision`**: `String` --- **`revisionScheme`**: `String` --- **`sourcingStrategy`**: `Sourcingstrategyenum` --- **`status`**: `partstatusenumpartstatusenum` --- **`supplierPartNumber`**: `String` --- **`thumbnailId`**: `ID` --- **`trackingType`**: `Trackingtypeenum` --- **`unitOfMeasureId`**: `Int` # UpdatePartInventory Source: https://docs.firstresonance.io/api-reference/types/UpdatePartInventory Update a PartInventory given an UpdatePartInventoryInput. **Kind**: `object` ## Fields **`partInventory`**: `PartInventory` --- **`splitInventory`**: `PartInventory` # UpdatePartInventoryAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePartInventoryAttribute **Kind**: `object` ## Fields **`partInventoryAttribute`**: `PartInventoryAttribute` # UpdatePartInventoryAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartInventoryAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`partInventoryId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePartInventoryAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePartInventoryAttributes **Kind**: `object` ## Fields **`partInventoryAttributes`**: `[PartInventoryAttribute]` # UpdatePartInventoryInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartInventoryInput Inputs needed to update a PartInventory. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`autogenerateLotNumber`**: `Boolean` --- **`autogenerateSerialNumber`**: `Boolean` In the future, this input will not support a boolean 'autogenerate_serial_type'. Use autogenerate_serial_type field with SerialGeneratorType.REVISION --- **`autogenerateSerialType`**: `SerialGeneratorType` --- **`cost`**: `Decimal` --- **`estimatedArrival`**: `DateTime` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`intentOptionId`**: `Int` --- **`lastMaintainedDate`**: `DateTime` --- **`locationId`**: `ID` --- **`lotNumber`**: `String` --- **`needDate`**: `DateTime` --- **`partId`**: `ID` --- **`quantity`**: `Float` --- **`quantityScrapped`**: `Float` --- **`serialNumber`**: `String` --- **`supplierId`**: `ID` --- **`unavailable`**: `Boolean` --- **`unitOfMeasureId`**: `ID` --- **`uri`**: `String` # UpdatePartKit Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKit **Kind**: `object` ## Fields **`partKit`**: `PartKit` # UpdatePartKitAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitAttribute **Kind**: `object` ## Fields **`partKitAttribute`**: `PartKitAttribute` # UpdatePartKitAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`partKitId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePartKitAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitAttributes **Kind**: `object` ## Fields **`partKitAttributes`**: `[PartKitAttribute]` # UpdatePartKitInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitInput Inputs needed to update object. **Kind**: `input` ## Fields **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`deliveryLocationId`**: `Int` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`locationId`**: `Int` --- **`runId`**: `Int` --- **`status`**: `Partkitstatusenum` # UpdatePartKitItem Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitItem **Kind**: `object` ## Fields **`partKitItem`**: `PartKitItem` # UpdatePartKitItemAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitItemAttribute **Kind**: `object` ## Fields **`partKitItemAttribute`**: `PartKitItemAttribute` # UpdatePartKitItemAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitItemAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`partKitItemId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePartKitItemAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitItemAttributes **Kind**: `object` ## Fields **`partKitItemAttributes`**: `[PartKitItemAttribute]` # UpdatePartKitItemInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKitItemInput Inputs needed to update object. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`originMbomItemId`**: `Int` --- **`partId`**: `Int` --- **`quantity`**: `Float` # UpdatePartKits Source: https://docs.firstresonance.io/api-reference/types/UpdatePartKits **Kind**: `object` ## Fields **`partKits`**: `[PartKit]` # UpdatePartProcedure Source: https://docs.firstresonance.io/api-reference/types/UpdatePartProcedure **Kind**: `object` ## Fields **`partProcedure`**: `PartProcedure` # UpdatePartProcedureInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartProcedureInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID` --- **`partId`**: `ID!` (required) --- **`pinnedMbomId`**: `ID` --- **`procedureId`**: `ID!` (required) --- **`required`**: `Boolean` --- **`status`**: `partprocedurestatusreviewstatusenum` # UpdatePartRevisionSchemeSettingInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartRevisionSchemeSettingInput Input to update part revision from organization settings. **Kind**: `input` ## Fields **`allowOverflow`**: `Boolean` --- **`default`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String!` (required) # UpdatePartSubtype Source: https://docs.firstresonance.io/api-reference/types/UpdatePartSubtype **Kind**: `object` ## Fields **`partSubtype`**: `PartSubtype` # UpdatePartSubtypeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePartSubtypeInput **Kind**: `input` ## Fields **`description`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` # UpdatePlan Source: https://docs.firstresonance.io/api-reference/types/UpdatePlan **Kind**: `object` ## Fields **`plan`**: `Plan` # UpdatePlanAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanAttribute **Kind**: `object` ## Fields **`planAttribute`**: `PlanAttribute` # UpdatePlanAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`planId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePlanAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanAttributes **Kind**: `object` ## Fields **`planAttributes`**: `[PlanAttribute]` # UpdatePlanConstraint Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanConstraint **Kind**: `object` ## Fields **`planConstraint`**: `PlanConstraint` # UpdatePlanConstraintInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanConstraintInput Inputs needed to update a plan constraint. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`locationIds`**: `[Int]` --- **`operator`**: `ConstraintOperator` --- **`planId`**: `Int` # UpdatePlanInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanInput Inputs needed to update a plan. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`includeInMrp`**: `Boolean` --- **`name`**: `String` --- **`status`**: `PlanStatus` # UpdatePlanItem Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanItem **Kind**: `object` ## Fields **`planItem`**: `PlanItem` # UpdatePlanItemAllocation Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanItemAllocation **Kind**: `object` ## Fields **`planItemAllocation`**: `PlanItemAllocation` # UpdatePlanItemAllocationInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanItemAllocationInput **Kind**: `input` ## Fields **`childPlanItemId`**: `ID!` (required) --- **`etag`**: `String!` (required) --- **`mrpJobId`**: `ID` --- **`parentPlanItemId`**: `ID!` (required) --- **`quantity`**: `Float` # UpdatePlanItemInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanItemInput **Kind**: `input` ## Fields **`assignedToId`**: `ID` --- **`endTime`**: `DateTime` --- **`etag`**: `String!` (required) --- **`explode`**: `Boolean` --- **`forecastedEndTime`**: `DateTime` --- **`forecastedStartTime`**: `DateTime` --- **`id`**: `ID!` (required) --- **`isBlocked`**: `Boolean` --- **`isFirm`**: `Boolean` --- **`isPlaceholder`**: `Boolean` --- **`mrpJobId`**: `ID` --- **`name`**: `String` --- **`partId`**: `ID` --- **`procedureId`**: `ID` --- **`quantity`**: `Float` --- **`startTime`**: `DateTime` --- **`supplierId`**: `ID` # UpdatePlanReservation Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanReservation **Kind**: `object` ## Fields **`planReservation`**: `PlanReservation` # UpdatePlanReservationInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePlanReservationInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`partInventoryId`**: `ID` --- **`planId`**: `ID` --- **`quantity`**: `Float` # UpdateProcedure Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedure Updates a Procedure given an UpdateProcedureInput argument. **Kind**: `object` ## Fields **`procedure`**: `Procedure` # UpdateProcedureApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureApproval **Kind**: `object` ## Fields **`approval`**: `ProcedureApproval` # UpdateProcedureApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureApprovalInput Inputs needed to update procedure approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`gateType`**: `Procedureapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `Int` # UpdateProcedureApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `ProcedureApprovalRequest` # UpdateProcedureApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureApprovalRequestInput Inputs needed to update procedure approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`gateType`**: `Procedureapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateProcedureApprovalRole Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `ProcedureApprovalRole` # UpdateProcedureApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureApprovalRoleInput Input needed to delete update approval roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`gateType`**: `Procedureapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # UpdateProcedureAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureAttribute **Kind**: `object` ## Fields **`procedureAttribute`**: `ProcedureAttribute` # UpdateProcedureAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`procedureId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateProcedureAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureAttributes **Kind**: `object` ## Fields **`procedureAttributes`**: `[ProcedureAttribute]` # UpdateProcedureInput Source: https://docs.firstresonance.io/api-reference/types/UpdateProcedureInput Inputs needed to update a Procedure. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`exportControlled`**: `Boolean` --- **`id`**: `ID!` (required) --- **`intentOptionId`**: `Int` --- **`status`**: `Procedurestatusenum` --- **`title`**: `String` --- **`type`**: `Proceduretypeenum` # UpdateProject Source: https://docs.firstresonance.io/api-reference/types/UpdateProject **Kind**: `object` ## Fields **`project`**: `Project` # UpdateProjectInput Source: https://docs.firstresonance.io/api-reference/types/UpdateProjectInput Inputs needed to update a project. **Kind**: `input` ## Fields **`archived`**: `Boolean` --- **`code`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`title`**: `String` # UpdatePurchaseOrder Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrder **Kind**: `object` ## Fields **`purchaseOrder`**: `PurchaseOrder` # UpdatePurchaseOrderApproval Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderApproval **Kind**: `object` ## Fields **`approval`**: `PurchaseOrderApproval` # UpdatePurchaseOrderApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderApprovalInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdatePurchaseOrderApprovalLevel Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderApprovalLevel **Kind**: `object` ## Fields **`purchaseOrderApprovalLevel`**: `PurchaseOrderApprovalLevel` # UpdatePurchaseOrderApprovalLevelInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderApprovalLevelInput Inputs needed to update object. **Kind**: `input` ## Fields **`assignedUserId`**: `Int` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`status`**: `ApprovalStatus` --- **`teamId`**: `Int` # UpdatePurchaseOrderApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `PurchaseOrderApprovalRequest` # UpdatePurchaseOrderApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderApprovalRequestInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`purchaseOrderId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdatePurchaseOrderAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderAttribute **Kind**: `object` ## Fields **`purchaseOrderAttribute`**: `PurchaseOrderAttribute` # UpdatePurchaseOrderAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`purchaseOrderId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePurchaseOrderAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderAttributes **Kind**: `object` ## Fields **`purchaseOrderAttributes`**: `[PurchaseOrderAttribute]` # UpdatePurchaseOrderFee Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderFee **Kind**: `object` ## Fields **`purchaseOrderFee`**: `PurchaseOrderFee` # UpdatePurchaseOrderFeeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderFeeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`purchaseOrderId`**: `ID` --- **`type`**: `Feetypeenum` --- **`value`**: `Float` # UpdatePurchaseOrderInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderInput Inputs needed to update object. **Kind**: `input` ## Fields **`assignedTeamId`**: `Int` --- **`assignedToId`**: `Int` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`billToLocationId`**: `Int` --- **`cost`**: `Float` --- **`currencyId`**: `Int` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`externalReference`**: `String` --- **`id`**: `Int!` (required) --- **`intentOptionId`**: `Int` --- **`orderedAt`**: `DateTime` --- **`paid`**: `Boolean` --- **`shipToLocationId`**: `Int` --- **`status`**: `Purchaseorderstatusenum` --- **`supplierId`**: `Int` --- **`supplierInstructions`**: `SlateContent` # UpdatePurchaseOrderLine Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderLine Updates Purchase Order Line. **Kind**: `object` ## Fields **`purchaseOrderLine`**: `PurchaseOrderLine` # UpdatePurchaseOrderLineAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderLineAttribute **Kind**: `object` ## Fields **`purchaseOrderLineAttribute`**: `PurchaseOrderLineAttribute` # UpdatePurchaseOrderLineAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderLineAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`purchaseOrderLineId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdatePurchaseOrderLineAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderLineAttributes **Kind**: `object` ## Fields **`purchaseOrderLineAttributes`**: `[PurchaseOrderLineAttribute]` # UpdatePurchaseOrderLineInput Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderLineInput Inputs needed to update object. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`chargeAccountId`**: `ID` --- **`cost`**: `Float` --- **`description`**: `String` --- **`estimatedArrivalDate`**: `DateTime` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`intentOptionId`**: `Int` --- **`needDate`**: `DateTime` --- **`originalEstimatedArrivalDate`**: `DateTime` --- **`paid`**: `Boolean` --- **`partId`**: `Int` --- **`percentageFeeExempt`**: `Boolean` --- **`projectId`**: `ID` --- **`purchaseOrderId`**: `Int` --- **`quantity`**: `Float` --- **`runStepId`**: `Int` --- **`status`**: `Purchaseorderstatusenum` --- **`supplierPartId`**: `Int` # UpdatePurchaseOrderLines Source: https://docs.firstresonance.io/api-reference/types/UpdatePurchaseOrderLines **Kind**: `object` ## Fields **`purchaseOrderLines`**: `[PurchaseOrderLine]` # UpdateReceipt Source: https://docs.firstresonance.io/api-reference/types/UpdateReceipt **Kind**: `object` ## Fields **`receipt`**: `Receipt` # UpdateReceiptAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateReceiptAttribute **Kind**: `object` ## Fields **`receiptAttribute`**: `ReceiptAttribute` # UpdateReceiptAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateReceiptAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`receiptId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateReceiptAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateReceiptAttributes **Kind**: `object` ## Fields **`receiptAttributes`**: `[ReceiptAttribute]` # UpdateReceiptInput Source: https://docs.firstresonance.io/api-reference/types/UpdateReceiptInput Custom inputs to update receipt. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`receivedAt`**: `DateTime` --- **`receivedById`**: `Int` # UpdateReceiptItem Source: https://docs.firstresonance.io/api-reference/types/UpdateReceiptItem **Kind**: `object` ## Fields **`receiptItem`**: `ReceiptItem` # UpdateReceiptItemInput Source: https://docs.firstresonance.io/api-reference/types/UpdateReceiptItemInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`partInventoryId`**: `ID` --- **`purchaseOrderLineId`**: `ID` --- **`quantity`**: `Float` --- **`receiptId`**: `ID` # UpdateRedline Source: https://docs.firstresonance.io/api-reference/types/UpdateRedline **Kind**: `object` ## Fields **`redline`**: `Redline` # UpdateRedlineApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApproval **Kind**: `object` ## Fields **`approval`**: `RedlineApproval` # UpdateRedlineApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApprovalInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`redlineId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateRedlineApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `RedlineApprovalRequest` # UpdateRedlineApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApprovalRequestInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`redlineId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateRedlineApprovalRequests Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApprovalRequests **Kind**: `object` ## Fields **`approvalRequests`**: `[RedlineApprovalRequest]` # UpdateRedlineApprovalRole Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `RedlineApprovalRole` # UpdateRedlineApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineApprovalRoleInput Input needed to update redline approval roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`gateType`**: `Redlineapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # UpdateRedlineInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineInput Inputs needed to update a Redline. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`issueId`**: `Int` # UpdateRedlineRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineRoleBasedApproval **Kind**: `object` ## Fields **`approval`**: `RedlineRoleBasedApproval` # UpdateRedlineRoleBasedApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineRoleBasedApprovalInput Inputs needed to update redline role-based approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`gateType`**: `Redlineapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateRedlineRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineRoleBasedApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `RedlineRoleBasedApprovalRequest` # UpdateRedlineRoleBasedApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineRoleBasedApprovalRequestInput Inputs needed to update redline role-based approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`gateType`**: `Redlineapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateRedlineRoleBasedApprovalRequests Source: https://docs.firstresonance.io/api-reference/types/UpdateRedlineRoleBasedApprovalRequests **Kind**: `object` ## Fields **`approvalRequests`**: `[RedlineRoleBasedApprovalRequest]` # UpdateRequirement Source: https://docs.firstresonance.io/api-reference/types/UpdateRequirement **Kind**: `object` ## Fields **`requirement`**: `Requirement` # UpdateRequirementInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRequirementInput **Kind**: `input` ## Fields **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`referenceName`**: `String` --- **`title`**: `String` # UpdateReview Source: https://docs.firstresonance.io/api-reference/types/UpdateReview **Kind**: `object` ## Fields **`review`**: `Review` # UpdateReviewInput Source: https://docs.firstresonance.io/api-reference/types/UpdateReviewInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`procedureId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID` # UpdateReviewRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateReviewRequest **Kind**: `object` ## Fields **`reviewRequest`**: `ReviewRequest` # UpdateReviewRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateReviewRequestInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`procedureId`**: `ID` --- **`reviewerId`**: `ID` --- **`status`**: `Reviewstatusenum` # UpdateRole Source: https://docs.firstresonance.io/api-reference/types/UpdateRole **Kind**: `object` ## Fields **`role`**: `Role` # UpdateRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRoleInput **Kind**: `input` ## Fields **`archived`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` # UpdateRule Source: https://docs.firstresonance.io/api-reference/types/UpdateRule **Kind**: `object` ## Fields **`rule`**: `Rule` # UpdateRuleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRuleInput Inputs needed to create a rule. **Kind**: `input` ## Fields **`aiDescription`**: `String` --- **`code`**: `String` --- **`context`**: `String` --- **`enabled`**: `Boolean` --- **`errorState`**: `RuleErrorState` --- **`etag`**: `String!` (required) --- **`eventType`**: `RuleEventType` --- **`id`**: `Int!` (required) --- **`ruleType`**: `RuleType` --- **`target`**: `RuleTargetEnum` --- **`title`**: `String` --- **`version`**: `Int` = 1 # UpdateRun Source: https://docs.firstresonance.io/api-reference/types/UpdateRun **Kind**: `object` ## Fields **`run`**: `Run` # UpdateRunAbomJustification Source: https://docs.firstresonance.io/api-reference/types/UpdateRunAbomJustification Update the ABOM completion justification text on a run (for auto-save). **Kind**: `object` ## Fields **`run`**: `Run` # UpdateRunAbomJustificationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunAbomJustificationInput Input for updating the ABOM completion justification text on a run. **Kind**: `input` ## Fields **`justification`**: `String!` (required) --- **`runId`**: `Int!` (required) # UpdateRunAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateRunAttribute **Kind**: `object` ## Fields **`runAttribute`**: `RunAttribute` # UpdateRunAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`runId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateRunAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateRunAttributes **Kind**: `object` ## Fields **`runAttributes`**: `[RunAttribute]` # UpdateRunBatch Source: https://docs.firstresonance.io/api-reference/types/UpdateRunBatch **Kind**: `object` ## Fields **`runBatch`**: `RunBatch` # UpdateRunBatchInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunBatchInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`title`**: `String` # UpdateRunInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunInput Inputs needed to update a Run. **Kind**: `input` ## Fields **`addToNewBatch`**: `Boolean` --- **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`description`**: `String` --- **`dueDate`**: `DateTime` --- **`etag`**: `String!` (required) --- **`exportControlled`**: `Boolean` --- **`id`**: `ID!` (required) --- **`intentOptionId`**: `Int` --- **`jiraIssueKey`**: `String` --- **`partId`**: `ID` This field will be deprecated in a future release. Update through the part inventory instead. --- **`partInventoryId`**: `ID` --- **`quantity`**: `Int` --- **`resultsLink`**: `String` --- **`runBatchId`**: `Int` --- **`runBatchTitle`**: `String` --- **`scheduledEnd`**: `DateTime` --- **`scheduledStart`**: `DateTime` --- **`title`**: `String` # UpdateRunInventoryLocation Source: https://docs.firstresonance.io/api-reference/types/UpdateRunInventoryLocation Moves a runs part inventory and its siblings to another location. **Kind**: `object` ## Fields **`run`**: `Run` # UpdateRunInventoryLocationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunInventoryLocationInput Inputs needed to move a Run's inventory and its siblings. **Kind**: `input` ## Fields **`locationId`**: `ID!` (required) --- **`moveBatch`**: `Boolean` --- **`runId`**: `ID!` (required) # UpdateRunStep Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStep Updates a RunStep given a UpdateRunStepInput argument. **Kind**: `object` ## Fields **`dispositionApplied`**: `Boolean` Whether the requested output inventory disposition reached the run's output inventory. False when the run stayed open or had no eligible output. Null when no disposition was requested. --- **`runStep`**: `RunStep` # UpdateRunStepAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepAttribute **Kind**: `object` ## Fields **`runStepAttribute`**: `RunStepAttribute` # UpdateRunStepAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`runStepId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateRunStepAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepAttributes **Kind**: `object` ## Fields **`runStepAttributes`**: `[RunStepAttribute]` # UpdateRunStepBuildRequirement Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepBuildRequirement Update a run step's per-step build-requirement quantity. **Kind**: `object` ## Fields **`runStepBuildRequirement`**: `RunStepBuildRequirementMaterialized` # UpdateRunStepBuildRequirementInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepBuildRequirementInput Update a run step's per-step build-requirement quantity. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `String!` (required) --- **`quantity`**: `Float!` (required) # UpdateRunStepField Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepField Updates RunStepFields during redlining. **Kind**: `object` ## Fields **`runStepField`**: `RunStepField` # UpdateRunStepFieldInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepFieldInput Inputs needed to update a RunStepField. **Kind**: `input` ## Fields **`allowNotApplicable`**: `Boolean` --- **`allowedIonType`**: `runstepfieldiontypeentitytypeenum` --- **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`display`**: `String` --- **`etag`**: `String!` (required) --- **`helpText`**: `String` --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`options`**: `[String]` --- **`partId`**: `Int` --- **`partSubtypeId`**: `Int` --- **`peerReviewRequired`**: `Boolean` --- **`required`**: `Boolean` --- **`signoffRoleId`**: `Int` --- **`type`**: `runstepfieldfieldtypes` --- **`unit`**: `String` --- **`value`**: `ScalarValue` In the future, this mutation will not support updating "value". Use UpdateRunStepFieldValue to update the "value" for a field. # UpdateRunStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepFieldValidation **Kind**: `object` ## Fields **`runStepFieldValidation`**: `RunStepFieldValidation` # UpdateRunStepFieldValidationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepFieldValidationInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`functionId`**: `ID` --- **`id`**: `ID!` (required) --- **`position`**: `Int` --- **`value`**: `Float` # UpdateRunStepFieldValue Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepFieldValue Updates a RunStepField value given UpdateRunStepFieldValue Input argument. **Kind**: `object` ## Fields **`runStepField`**: `RunStepField` # UpdateRunStepFieldValueInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepFieldValueInput Inputs needed to update a RunStepFieldValue during redlining. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`notApplicable`**: `Boolean` --- **`value`**: `ScalarValue` # UpdateRunStepInput Source: https://docs.firstresonance.io/api-reference/types/UpdateRunStepInput Inputs needed to update a RunStep. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`content`**: `String` --- **`datagrid`**: `DataGridInput` --- **`displayPdf`**: `Boolean` --- **`disposition`**: `RunCancellationDisposition` What happens to the run's output inventory if this step update makes the run FAILED. Defaults to DEFER (send to the review queue). --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`isOutsideProcess`**: `Boolean` --- **`leadTime`**: `Int` --- **`locationId`**: `ID` --- **`parentId`**: `ID` --- **`scheduledEnd`**: `DateTime` --- **`scheduledStart`**: `DateTime` --- **`slateContent`**: `SlateContent` --- **`status`**: `Statusenum` --- **`title`**: `String` --- **`type`**: `runstepsteptypes` # UpdateRuns Source: https://docs.firstresonance.io/api-reference/types/UpdateRuns Updates Runs given a list of UpdateRunInput argument. **Kind**: `object` ## Fields **`runs`**: `[Run]` # UpdateSession Source: https://docs.firstresonance.io/api-reference/types/UpdateSession **Kind**: `object` ## Fields **`session`**: `Session` # UpdateSessionInput Source: https://docs.firstresonance.io/api-reference/types/UpdateSessionInput Input for Update Run Step Session. **Kind**: `input` ## Fields **`assignedUserId`**: `Int` --- **`checkIn`**: `DateTime` Time in UTC. Format is offset unaware: "2020-08-20T18:48:19". Omitting this value does not change the check in time. --- **`checkOut`**: `DateTime` Time in UTC. Format is offset unaware: "2020-08-20T18:48:19". Omitting this value does not change the check out time. --- **`durationInSeconds`**: `Float` Time in seconds. Only supply this value or a check out value, not both. --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) # UpdateSnapshotExportJob Source: https://docs.firstresonance.io/api-reference/types/UpdateSnapshotExportJob **Kind**: `object` ## Fields **`snapshotExportJob`**: `SnapshotExportJob` # UpdateSnapshotExportJobInput Source: https://docs.firstresonance.io/api-reference/types/UpdateSnapshotExportJobInput **Kind**: `input` ## Fields **`destination`**: `SnapshotExportJobDestination` --- **`errors`**: `JSONString` --- **`etag`**: `String!` (required) --- **`exportDuration`**: `Int` --- **`exportFiles`**: `JSONString` --- **`exportOptions`**: `JSONString` --- **`failedReason`**: `String` --- **`fileKey`**: `String` --- **`fileSizeBytes`**: `Float` --- **`filename`**: `String` --- **`id`**: `ID!` (required) --- **`status`**: `SnapshotExportJobStatus` --- **`type`**: `Snapshotexportjobtypeenum` # UpdateStep Source: https://docs.firstresonance.io/api-reference/types/UpdateStep Updates a step given a UpdateStepInput. **Kind**: `object` ## Fields **`step`**: `Step` # UpdateStepApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateStepApproval **Kind**: `object` ## Fields **`approval`**: `StepApproval` # UpdateStepApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepApprovalInput **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateStepApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateStepApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `StepApprovalRequest` # UpdateStepApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepApprovalRequestInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`status`**: `reviewreviewstatusenum` --- **`stepId`**: `ID` # UpdateStepApprovalRole Source: https://docs.firstresonance.io/api-reference/types/UpdateStepApprovalRole **Kind**: `object` ## Fields **`approvalRole`**: `StepApprovalRole` # UpdateStepApprovalRoleInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepApprovalRoleInput Input needed to delete update approval roles. **Kind**: `input` ## Fields **`count`**: `Int` --- **`etag`**: `String!` (required) --- **`gateType`**: `Stepapprovalgatetypeenum!` (required) --- **`roleId`**: `Int!` (required) # UpdateStepAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateStepAttribute **Kind**: `object` ## Fields **`stepAttribute`**: `StepAttribute` # UpdateStepAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`stepId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateStepAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateStepAttributes **Kind**: `object` ## Fields **`stepAttributes`**: `[StepAttribute]` # UpdateStepField Source: https://docs.firstresonance.io/api-reference/types/UpdateStepField Updates a StepField given a UpdateStepField argument. **Kind**: `object` ## Fields **`stepField`**: `StepField` # UpdateStepFieldInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepFieldInput Inputs needed to update a StepField. **Kind**: `input` ## Fields **`allowNotApplicable`**: `Boolean` --- **`allowedIonType`**: `stepfieldiontypeentitytypeenum` --- **`display`**: `String` --- **`etag`**: `String!` (required) --- **`helpText`**: `String` --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`options`**: `[String]` --- **`partId`**: `Int` --- **`partSubtypeId`**: `Int` --- **`peerReviewRequired`**: `Boolean` --- **`required`**: `Boolean` --- **`signoffRoleId`**: `Int` --- **`type`**: `Fieldtypes` --- **`unit`**: `String` # UpdateStepFieldValidation Source: https://docs.firstresonance.io/api-reference/types/UpdateStepFieldValidation **Kind**: `object` ## Fields **`stepFieldValidation`**: `StepFieldValidation` # UpdateStepFieldValidationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepFieldValidationInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`fieldId`**: `ID` --- **`functionId`**: `ID` --- **`id`**: `ID!` (required) --- **`position`**: `Int` --- **`value`**: `Float` # UpdateStepInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepInput Inputs needed to update a step. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`breakStandardStepLink`**: `Boolean` --- **`content`**: `String` --- **`datagrid`**: `DataGridInput` --- **`displayPdf`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`intentOptionId`**: `Int` --- **`isOutsideProcess`**: `Boolean` --- **`leadTime`**: `Int` --- **`locationId`**: `ID` --- **`locationSubtypeId`**: `ID` --- **`parentId`**: `ID` --- **`procedureId`**: `ID` --- **`slateContent`**: `SlateContent` --- **`standardStepStatus`**: `Standardstepstatusenum` --- **`title`**: `String` --- **`type`**: `Steptypes` # UpdateStepPartRequirement Source: https://docs.firstresonance.io/api-reference/types/UpdateStepPartRequirement Update step part requirement. **Kind**: `object` ## Fields **`stepPartRequirement`**: `StepPartRequirement` # UpdateStepPartRequirementInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepPartRequirementInput Input for UpdateStepPartRequirement. **Kind**: `input` ## Fields **`assignedReferenceDesignatorIds`**: `[Int]` --- **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`quantity`**: `Float` # UpdateStepPositionInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepPositionInput Inputs needed to update StepPosition. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `Int!` (required) --- **`position`**: `Int!` (required) # UpdateStepRoleBasedApproval Source: https://docs.firstresonance.io/api-reference/types/UpdateStepRoleBasedApproval **Kind**: `object` ## Fields **`approval`**: `StepRoleBasedApproval` # UpdateStepRoleBasedApprovalInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepRoleBasedApprovalInput Inputs needed to update step role based approval. **Kind**: `input` ## Fields **`comment`**: `String` --- **`content`**: `SlateContent` --- **`etag`**: `String!` (required) --- **`gateType`**: `Stepapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`parentId`**: `ID` --- **`resolved`**: `Boolean` --- **`status`**: `reviewreviewstatusenum` # UpdateStepRoleBasedApprovalRequest Source: https://docs.firstresonance.io/api-reference/types/UpdateStepRoleBasedApprovalRequest **Kind**: `object` ## Fields **`approvalRequest`**: `StepRoleBasedApprovalRequest` # UpdateStepRoleBasedApprovalRequestInput Source: https://docs.firstresonance.io/api-reference/types/UpdateStepRoleBasedApprovalRequestInput Inputs needed to update step role based approval request. **Kind**: `input` ## Fields **`assignedTeamId`**: `ID` --- **`assignedToId`**: `ID` --- **`etag`**: `String!` (required) --- **`gateType`**: `Stepapprovalgatetypeenum` --- **`id`**: `ID!` (required) --- **`roleId`**: `ID` --- **`status`**: `reviewreviewstatusenum` # UpdateSupplier Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplier **Kind**: `object` ## Fields **`supplier`**: `Supplier` # UpdateSupplierAttribute Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplierAttribute **Kind**: `object` ## Fields **`supplierAttribute`**: `SupplierAttribute` # UpdateSupplierAttributeInput Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplierAttributeInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`key`**: `String!` (required) --- **`supplierId`**: `Int!` (required) --- **`value`**: `ScalarValue` # UpdateSupplierAttributes Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplierAttributes **Kind**: `object` ## Fields **`supplierAttributes`**: `[SupplierAttribute]` # UpdateSupplierInput Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplierInput Inputs needed to update object. **Kind**: `input` ## Fields **`address`**: `String` --- **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`contactName`**: `String` --- **`description`**: `String` --- **`email`**: `String` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`phoneNumber`**: `String` # UpdateSupplierPart Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplierPart **Kind**: `object` ## Fields **`supplierPart`**: `SupplierPart` # UpdateSupplierPartInput Source: https://docs.firstresonance.io/api-reference/types/UpdateSupplierPartInput **Kind**: `input` ## Fields **`conversionFactor`**: `Float` --- **`cost`**: `Float` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`partId`**: `ID` --- **`supplierId`**: `ID` --- **`supplierPartNumber`**: `String` --- **`unitOfMeasure`**: `String` # UpdateTeam Source: https://docs.firstresonance.io/api-reference/types/UpdateTeam **Kind**: `object` ## Fields **`team`**: `Team` # UpdateTeamInput Source: https://docs.firstresonance.io/api-reference/types/UpdateTeamInput **Kind**: `input` ## Fields **`deactivated`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`supervisorId`**: `ID` # UpdateUnitOfMeasurement Source: https://docs.firstresonance.io/api-reference/types/UpdateUnitOfMeasurement **Kind**: `object` ## Fields **`unitOfMeasurement`**: `UnitOfMeasurement` # UpdateUnitOfMeasurementInput Source: https://docs.firstresonance.io/api-reference/types/UpdateUnitOfMeasurementInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`type`**: `String` # UpdateUser Source: https://docs.firstresonance.io/api-reference/types/UpdateUser **Kind**: `object` ## Fields **`user`**: `User` # UpdateUserInput Source: https://docs.firstresonance.io/api-reference/types/UpdateUserInput **Kind**: `input` ## Fields **`avatar`**: `String` --- **`deactivated`**: `Boolean` --- **`enforceMfa`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`isAdmin`**: `Boolean` --- **`locationId`**: `ID` --- **`name`**: `String` --- **`notificationEmailsEnabled`**: `Boolean` # UpdateUserNotification Source: https://docs.firstresonance.io/api-reference/types/UpdateUserNotification **Kind**: `object` ## Fields **`userNotification`**: `UserNotification` # UpdateUserNotificationInput Source: https://docs.firstresonance.io/api-reference/types/UpdateUserNotificationInput **Kind**: `input` ## Fields **`description`**: `String` --- **`etag`**: `String!` (required) --- **`externalLink`**: `String` --- **`id`**: `ID!` (required) --- **`linkText`**: `String` --- **`read`**: `Boolean` # UpdateWebhookHeader Source: https://docs.firstresonance.io/api-reference/types/UpdateWebhookHeader **Kind**: `object` ## Fields **`webhookHeader`**: `WebhookHeader` # UpdateWebhookHeaderInput Source: https://docs.firstresonance.io/api-reference/types/UpdateWebhookHeaderInput **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) --- **`key`**: `String` --- **`value`**: `String` # UpdateWebhookReceiver Source: https://docs.firstresonance.io/api-reference/types/UpdateWebhookReceiver **Kind**: `object` ## Fields **`webhookReceiver`**: `WebhookReceiver` # UpdateWebhookReceiverInput Source: https://docs.firstresonance.io/api-reference/types/UpdateWebhookReceiverInput **Kind**: `input` ## Fields **`active`**: `Boolean` --- **`contentType`**: `Webhookcontenttypesenum` --- **`description`**: `String` --- **`etag`**: `String!` (required) --- **`expectedResponseCode`**: `Int` --- **`id`**: `ID!` (required) --- **`name`**: `String` --- **`sharedSecret`**: `String` --- **`webhookUri`**: `String` # UpdateWebhookSubscription Source: https://docs.firstresonance.io/api-reference/types/UpdateWebhookSubscription **Kind**: `object` ## Fields **`webhookSubscription`**: `WebhookSubscription` # UpdateWebhookSubscriptionInput Source: https://docs.firstresonance.io/api-reference/types/UpdateWebhookSubscriptionInput **Kind**: `input` ## Fields **`active`**: `Boolean` --- **`etag`**: `String!` (required) --- **`id`**: `ID!` (required) # Upload Source: https://docs.firstresonance.io/api-reference/types/Upload Create scalar that ignores normal serialization/deserialization, since that will be handled by the multipart request spec **Kind**: `scalar` # UpsertPartInventoryOnReceiptItemInput Source: https://docs.firstresonance.io/api-reference/types/UpsertPartInventoryOnReceiptItemInput Updates inventory if id and etag are supplied, otherwise creates new inventory. **Kind**: `input` ## Fields **`attributes`**: `[NestedExtensibleAttributeInput]` --- **`autogenerateLotNumber`**: `Boolean` --- **`autogenerateSerialNumber`**: `Boolean` In the future, this input will not support a boolean 'autogenerate_serial_type'. Use autogenerate_serial_type field with SerialGeneratorType.REVISION --- **`autogenerateSerialType`**: `SerialGeneratorType` --- **`cost`**: `Decimal` --- **`estimatedArrival`**: `DateTime` --- **`etag`**: `String` --- **`id`**: `ID` --- **`intentOptionId`**: `Int` --- **`lastMaintainedDate`**: `DateTime` --- **`locationId`**: `ID` --- **`lotNumber`**: `String` --- **`needDate`**: `DateTime` --- **`partId`**: `ID` --- **`quantity`**: `Float` --- **`quantityScrapped`**: `Float` --- **`serialNumber`**: `String` --- **`supplierId`**: `ID` --- **`unavailable`**: `Boolean` --- **`unitOfMeasureId`**: `ID` --- **`uri`**: `String` # UpsertUserDefinedMessage Source: https://docs.firstresonance.io/api-reference/types/UpsertUserDefinedMessage Create, update, or delete a user-defined message by message_key. **Kind**: `object` ## Fields **`userDefinedMessage`**: `UserDefinedMessage` # UpsertUserDefinedMessageInput Source: https://docs.firstresonance.io/api-reference/types/UpsertUserDefinedMessageInput Inputs needed to upsert a user-defined message. **Kind**: `input` ## Fields **`etag`**: `String` --- **`message`**: `String!` (required) Empty string deletes the stored message for this key. --- **`messageKey`**: `UserDefinedMessageKey!` (required) # User Source: https://docs.firstresonance.io/api-reference/types/User A User of the ION platform. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`Organization`**: `Organization` > Deprecated: Use `organization` instead, `Organization` is deprecated. --- **`_ActiveSessionsCount`**: `Int` Optimized count of active sessions. --- **`_AnalyticsCredentialCount`**: `Int` Optimized count of analyticsCredential. --- **`_ApiKeysCount`**: `Int` Optimized count of apiKeys. --- **`_PermissionGroupsCount`**: `Int` Optimized count of permissionGroups. --- **`_RolesCount`**: `Int` Optimized count of Roles. --- **`_TeamsCount`**: `Int` Optimized count of teams. --- **`_UpdatedByCount`**: `Int` Optimized count of updatedBy. --- **`_UserRolesCount`**: `Int` Optimized count of userRoles. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`activeSessions`**: `[Session]` **Arguments:** - `filters`: `SessionsInputFilters` --- **`avatar`**: `String` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`deactivated`**: `Boolean!` --- **`email`**: `String` --- **`enforceMfa`**: `Boolean!` --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`ionBot`**: `Boolean!` --- **`isAdmin`**: `Boolean` --- **`lastLogin`**: `DateTime` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`location`**: `Location` **Arguments:** - `filters`: `LocationsInputFilters` --- **`locationId`**: `Int` --- **`name`**: `String` --- **`notificationEmailsEnabled`**: `Boolean!` --- **`organization`**: `Organization` --- **`organizationId`**: `Int!` --- **`permissionGroups`**: `[PermissionGroup]` --- **`prettyStr`**: `String` --- **`roles`**: `[Role]` **Arguments:** - `filters`: `RolesInputFilters` --- **`teams`**: `[Team]` **Arguments:** - `filters`: `TeamsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserEventFilter` --- **`updatedBy`**: `[User]` --- **`updatedById`**: `Int` --- **`userRoles`**: `[UserRole]` **Arguments:** - `filters`: `UserRolesInputFilters` # UserDefinedMessage Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessage A user-defined message keyed by a unique message_key. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`message`**: `String!` --- **`messageKey`**: `UserDefinedMessageKey!` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserDefinedMessageEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # UserDefinedMessageEventFilter Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessageEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`message`**: `StringFilter` --- **`messageKey`**: `UserDefinedMessageKeyFilter` --- **`updatedById`**: `IDFilter` # UserDefinedMessageEvents Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessageEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `UserDefinedMessage` --- **`oldValues`**: `UserDefinedMessage` --- **`timestamp`**: `DateTime` # UserDefinedMessageKey Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessageKey Allowed keys for org-level user-defined messages. Add a member here when a new message surface is supported. Stored value is the snake_case string (e.g. run_banner), unique per org schema. **Kind**: `enum` ## Values **`RUN_BANNER`** # UserDefinedMessageKeyFilter Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessageKeyFilter **Kind**: `input` ## Fields **`eq`**: `UserDefinedMessageKey` --- **`gt`**: `UserDefinedMessageKey` --- **`gte`**: `UserDefinedMessageKey` --- **`ilike`**: `UserDefinedMessageKey` --- **`in`**: `[UserDefinedMessageKey]` --- **`isnull`**: `Boolean` --- **`like`**: `UserDefinedMessageKey` --- **`lt`**: `UserDefinedMessageKey` --- **`lte`**: `UserDefinedMessageKey` --- **`neq`**: `UserDefinedMessageKey` --- **`notilike`**: `UserDefinedMessageKey` --- **`notlike`**: `UserDefinedMessageKey` # UserDefinedMessageSortEnum Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessageSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`MESSAGE_ASC`** **`MESSAGE_DESC`** **`MESSAGE_KEY_ASC`** **`MESSAGE_KEY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # UserDefinedMessagesConnection Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessagesConnection **Kind**: `object` ## Fields **`edges`**: `[UserDefinedMessagesEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # UserDefinedMessagesEdge Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessagesEdge A Relay edge containing a `UserDefinedMessages` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `UserDefinedMessage` The item at the end of the edge # UserDefinedMessagesInputFilters Source: https://docs.firstresonance.io/api-reference/types/UserDefinedMessagesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[UserDefinedMessagesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`message`**: `StringFilter` --- **`messageKey`**: `UserDefinedMessageKeyFilter` --- **`or_`**: `[UserDefinedMessagesInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # UserEventFilter Source: https://docs.firstresonance.io/api-reference/types/UserEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`avatar`**: `StringFilter` --- **`deactivated`**: `BooleanFilter` --- **`email`**: `StringFilter` --- **`enforceMfa`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`ionBot`**: `BooleanFilter` --- **`isAdmin`**: `BooleanFilter` --- **`lastLogin`**: `DateTimeFilter` --- **`locationId`**: `IDFilter` --- **`name`**: `StringFilter` --- **`notificationEmailsEnabled`**: `BooleanFilter` --- **`organizationId`**: `IDFilter` --- **`updatedById`**: `IDFilter` # UserEvents Source: https://docs.firstresonance.io/api-reference/types/UserEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `User` --- **`oldValues`**: `User` --- **`timestamp`**: `DateTime` # UserInputFilters Source: https://docs.firstresonance.io/api-reference/types/UserInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`activeSessions`**: `SessionsInputFilters` --- **`and_`**: `[UserInputFilters]` --- **`avatar`**: `StringFilter` --- **`deactivated`**: `BooleanFilter` --- **`email`**: `StringFilter` --- **`enforceMfa`**: `BooleanFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`ionBot`**: `BooleanFilter` --- **`isAdmin`**: `BooleanFilter` --- **`lastLogin`**: `DateTimeFilter` --- **`location`**: `LocationsInputFilters` --- **`locationId`**: `IDFilter` --- **`name`**: `StringFilter` --- **`notificationEmailsEnabled`**: `BooleanFilter` --- **`or_`**: `[UserInputFilters]` --- **`organizationId`**: `IDFilter` --- **`roles`**: `RolesInputFilters` --- **`teams`**: `TeamsInputFilters` --- **`updatedById`**: `IDFilter` --- **`userRoles`**: `UserRolesInputFilters` # UserNotification Source: https://docs.firstresonance.io/api-reference/types/UserNotification A user notification. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`entityId`**: `Int` --- **`externalLink`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`linkText`**: `String` --- **`linkUrl`**: `String` --- **`path`**: `String` --- **`payload`**: `JSONString` --- **`prettyStr`**: `String` --- **`read`**: `Boolean!` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserNotificationEventFilter` --- **`title`**: `String` --- **`type`**: `NotificationTypeEnum!` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`userId`**: `Int!` # UserNotificationEventFilter Source: https://docs.firstresonance.io/api-reference/types/UserNotificationEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`externalLink`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`linkText`**: `StringFilter` --- **`path`**: `StringFilter` --- **`payload`**: `JSONStringFilter` --- **`read`**: `BooleanFilter` --- **`title`**: `StringFilter` --- **`type`**: `NotificationTypeEnumFilter` --- **`updatedById`**: `IDFilter` --- **`userId`**: `IDFilter` # UserNotificationEvents Source: https://docs.firstresonance.io/api-reference/types/UserNotificationEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `UserNotification` --- **`oldValues`**: `UserNotification` --- **`timestamp`**: `DateTime` # UserNotificationSortEnum Source: https://docs.firstresonance.io/api-reference/types/UserNotificationSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`EXTERNAL_LINK_ASC`** **`EXTERNAL_LINK_DESC`** **`ID_ASC`** **`ID_DESC`** **`LINK_TEXT_ASC`** **`LINK_TEXT_DESC`** **`PATH_ASC`** **`PATH_DESC`** **`READ_ASC`** **`READ_DESC`** **`TITLE_ASC`** **`TITLE_DESC`** **`TYPE_ASC`** **`TYPE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`USER_ID_ASC`** **`USER_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # UserNotificationsConnection Source: https://docs.firstresonance.io/api-reference/types/UserNotificationsConnection **Kind**: `object` ## Fields **`edges`**: `[UserNotificationsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # UserNotificationsEdge Source: https://docs.firstresonance.io/api-reference/types/UserNotificationsEdge A Relay edge containing a `UserNotifications` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `UserNotification` The item at the end of the edge # UserNotificationsInputFilters Source: https://docs.firstresonance.io/api-reference/types/UserNotificationsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[UserNotificationsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`entityId`**: `IDFilter` --- **`externalLink`**: `StringFilter` --- **`id`**: `IDFilter` --- **`linkText`**: `StringFilter` --- **`or_`**: `[UserNotificationsInputFilters]` --- **`path`**: `StringFilter` --- **`payload`**: `JSONStringNullFilter` --- **`read`**: `BooleanFilter` --- **`title`**: `StringFilter` --- **`type`**: `NotificationTypeEnumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`userId`**: `IDFilter` # UserRole Source: https://docs.firstresonance.io/api-reference/types/UserRole A role a User has within the ION platform. **Kind**: `object` ## Fields **`Updated`**: `DateTime` --- **`_created`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdById`**: `Int` User id that created this object. Returns: int of user_id --- **`roleId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserRoleEventFilter` --- **`user`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`userId`**: `Int` # UserRoleEventFilter Source: https://docs.firstresonance.io/api-reference/types/UserRoleEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`roleId`**: `IDFilter` --- **`userId`**: `IDFilter` # UserRoleEvents Source: https://docs.firstresonance.io/api-reference/types/UserRoleEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `UserRole` --- **`oldValues`**: `UserRole` --- **`timestamp`**: `DateTime` # UserRolesInputFilters Source: https://docs.firstresonance.io/api-reference/types/UserRolesInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[UserRolesInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`or_`**: `[UserRolesInputFilters]` --- **`roleId`**: `IDFilter` --- **`user`**: `UserInputFilters` --- **`userId`**: `IDFilter` # UserSortEnum Source: https://docs.firstresonance.io/api-reference/types/UserSortEnum **Kind**: `enum` ## Values **`AUTH0_SUB_ASC`** **`AUTH0_SUB_DESC`** **`AVATAR_ASC`** **`AVATAR_DESC`** **`DEACTIVATED_ASC`** **`DEACTIVATED_DESC`** **`EMAIL_ASC`** **`EMAIL_DESC`** **`ENFORCE_MFA_ASC`** **`ENFORCE_MFA_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`ION_BOT_ASC`** **`ION_BOT_DESC`** **`IS_ADMIN_ASC`** **`IS_ADMIN_DESC`** **`LAST_LOGIN_ASC`** **`LAST_LOGIN_DESC`** **`LOCATION_ID_ASC`** **`LOCATION_ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`NOTIFICATION_EMAILS_ENABLED_ASC`** **`NOTIFICATION_EMAILS_ENABLED_DESC`** **`ORGANIZATION_ID_ASC`** **`ORGANIZATION_ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # UserSubscription Source: https://docs.firstresonance.io/api-reference/types/UserSubscription A user subscription. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`entity`**: `Entity` --- **`entityId`**: `Int!` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `UserSubscriptionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`user`**: `User` **Arguments:** - `filters`: `UserInputFilters` --- **`userId`**: `Int!` # UserSubscriptionEventFilter Source: https://docs.firstresonance.io/api-reference/types/UserSubscriptionEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`updatedById`**: `IDFilter` --- **`userId`**: `IDFilter` # UserSubscriptionEvents Source: https://docs.firstresonance.io/api-reference/types/UserSubscriptionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `UserSubscription` --- **`oldValues`**: `UserSubscription` --- **`timestamp`**: `DateTime` # UserSubscriptionSortEnum Source: https://docs.firstresonance.io/api-reference/types/UserSubscriptionSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ENTITY_ID_ASC`** **`ENTITY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`USER_ID_ASC`** **`USER_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # UserSubscriptionsConnection Source: https://docs.firstresonance.io/api-reference/types/UserSubscriptionsConnection **Kind**: `object` ## Fields **`edges`**: `[UserSubscriptionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # UserSubscriptionsEdge Source: https://docs.firstresonance.io/api-reference/types/UserSubscriptionsEdge A Relay edge containing a `UserSubscriptions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `UserSubscription` The item at the end of the edge # UserSubscriptionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/UserSubscriptionsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[UserSubscriptionsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`entityId`**: `IDFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[UserSubscriptionsInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`user`**: `UserInputFilters` --- **`userId`**: `IDFilter` # UsersConnection Source: https://docs.firstresonance.io/api-reference/types/UsersConnection **Kind**: `object` ## Fields **`edges`**: `[UsersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # UsersEdge Source: https://docs.firstresonance.io/api-reference/types/UsersEdge A Relay edge containing a `Users` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `User` The item at the end of the edge # ValidRunStepStatus Source: https://docs.firstresonance.io/api-reference/types/ValidRunStepStatus Valid status payload for a run step transition. **Kind**: `object` ## Fields **`isValid`**: `Boolean!` --- **`reason`**: `String` --- **`status`**: `Statusenum!` # ValidateImportCsvError Source: https://docs.firstresonance.io/api-reference/types/ValidateImportCsvError A single row-level validation error for an import CSV. **Kind**: `object` ## Fields **`error`**: `String!` --- **`row`**: `Int!` # ValidateImportCsvResult Source: https://docs.firstresonance.io/api-reference/types/ValidateImportCsvResult Result of synchronous pre-flight validation of an uploaded import CSV. **Kind**: `object` ## Fields **`durationSeconds`**: `Float` --- **`errors`**: `[ValidateImportCsvError]!` --- **`numRows`**: `Int` Number of rows validated (capped for large files). --- **`truncated`**: `Boolean` True if the file had more rows than were validated; the remainder is validated when the import is committed. --- **`valid`**: `Boolean!` # ValidationFunction Source: https://docs.firstresonance.io/api-reference/types/ValidationFunction Validation function GraphQL object. **Kind**: `object` ## Fields **`_RunValidationsCount`**: `Int` Optimized count of runValidations. --- **`_ValidationsCount`**: `Int` Optimized count of validations. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`displayName`**: `String` --- **`functionName`**: `String` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`runValidations`**: `[RunStepFieldValidation]` **Arguments:** - `filters`: `RunStepFieldValidationsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `ValidationFunctionEventFilter` --- **`validations`**: `[StepFieldValidation]` **Arguments:** - `filters`: `StepFieldValidationsInputFilters` # ValidationFunctionEventFilter Source: https://docs.firstresonance.io/api-reference/types/ValidationFunctionEventFilter **Kind**: `input` ## Fields **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`displayName`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`functionName`**: `StringFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` # ValidationFunctionEvents Source: https://docs.firstresonance.io/api-reference/types/ValidationFunctionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `ValidationFunction` --- **`oldValues`**: `ValidationFunction` --- **`timestamp`**: `DateTime` # ValidationFunctionSortEnum Source: https://docs.firstresonance.io/api-reference/types/ValidationFunctionSortEnum **Kind**: `enum` ## Values **`DISPLAY_NAME_ASC`** **`DISPLAY_NAME_DESC`** **`FUNCTION_NAME_ASC`** **`FUNCTION_NAME_DESC`** **`ID_ASC`** **`ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # ValidationFunctionsConnection Source: https://docs.firstresonance.io/api-reference/types/ValidationFunctionsConnection **Kind**: `object` ## Fields **`edges`**: `[ValidationFunctionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # ValidationFunctionsEdge Source: https://docs.firstresonance.io/api-reference/types/ValidationFunctionsEdge A Relay edge containing a `ValidationFunctions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `ValidationFunction` The item at the end of the edge # ValidationFunctionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/ValidationFunctionsInputFilters **Kind**: `input` ## Fields **`_updated`**: `DateTimeFilter` --- **`and_`**: `[ValidationFunctionsInputFilters]` --- **`displayName`**: `StringFilter` --- **`functionName`**: `StringFilter` --- **`id`**: `IDFilter` --- **`or_`**: `[ValidationFunctionsInputFilters]` --- **`runValidations`**: `RunStepFieldValidationsInputFilters` --- **`validations`**: `StepFieldValidationsInputFilters` # Validationresultenum Source: https://docs.firstresonance.io/api-reference/types/Validationresultenum **Kind**: `enum` ## Values **`FAIL`** **`PASS`** **`PENDING`** # ValidationresultenumFilter Source: https://docs.firstresonance.io/api-reference/types/ValidationresultenumFilter **Kind**: `input` ## Fields **`eq`**: `Validationresultenum` --- **`gt`**: `Validationresultenum` --- **`gte`**: `Validationresultenum` --- **`ilike`**: `Validationresultenum` --- **`in`**: `[Validationresultenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Validationresultenum` --- **`lt`**: `Validationresultenum` --- **`lte`**: `Validationresultenum` --- **`neq`**: `Validationresultenum` --- **`notilike`**: `Validationresultenum` --- **`notlike`**: `Validationresultenum` # VerifyOrganizationDomain Source: https://docs.firstresonance.io/api-reference/types/VerifyOrganizationDomain Trigger DNS TXT verification for a claimed domain. **Kind**: `object` ## Fields **`organizationDomain`**: `OrganizationDomain` # WebhookEvent Source: https://docs.firstresonance.io/api-reference/types/WebhookEvent The graphene sqlalchemy object type for webhook events. **Kind**: `object` ## Fields **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`numberOfRetries`**: `Int` --- **`prettyStr`**: `String` --- **`requestData`**: `String` --- **`responseData`**: `String` --- **`responseReceivedAt`**: `DateTime` --- **`responseStatusCode`**: `Int` --- **`status`**: `Webhookeventstatusenum!` --- **`subscription`**: `WebhookSubscription` **Arguments:** - `filters`: `WebhookSubscriptionsInputFilters` --- **`subscriptionId`**: `Int` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookEventEventFilter` # WebhookEventEventFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookEventEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`numberOfRetries`**: `IntFilter` --- **`requestData`**: `StringFilter` --- **`responseData`**: `StringFilter` --- **`responseReceivedAt`**: `DateTimeFilter` --- **`responseStatusCode`**: `IntFilter` --- **`status`**: `WebhookeventstatusenumFilter` --- **`subscriptionId`**: `IDFilter` # WebhookEventEvents Source: https://docs.firstresonance.io/api-reference/types/WebhookEventEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `WebhookEvent` --- **`oldValues`**: `WebhookEvent` --- **`timestamp`**: `DateTime` # WebhookEventSortEnum Source: https://docs.firstresonance.io/api-reference/types/WebhookEventSortEnum **Kind**: `enum` ## Values **`ID_ASC`** **`ID_DESC`** **`NUMBER_OF_RETRIES_ASC`** **`NUMBER_OF_RETRIES_DESC`** **`REQUEST_DATA_ASC`** **`REQUEST_DATA_DESC`** **`RESPONSE_DATA_ASC`** **`RESPONSE_DATA_DESC`** **`RESPONSE_RECEIVED_AT_ASC`** **`RESPONSE_RECEIVED_AT_DESC`** **`RESPONSE_STATUS_CODE_ASC`** **`RESPONSE_STATUS_CODE_DESC`** **`STATUS_ASC`** **`STATUS_DESC`** **`SUBSCRIPTION_ID_ASC`** **`SUBSCRIPTION_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # WebhookEventsConnection Source: https://docs.firstresonance.io/api-reference/types/WebhookEventsConnection **Kind**: `object` ## Fields **`edges`**: `[WebhookEventsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # WebhookEventsEdge Source: https://docs.firstresonance.io/api-reference/types/WebhookEventsEdge A Relay edge containing a `WebhookEvents` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `WebhookEvent` The item at the end of the edge # WebhookEventsInputFilters Source: https://docs.firstresonance.io/api-reference/types/WebhookEventsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[WebhookEventsInputFilters]` --- **`id`**: `IDFilter` --- **`numberOfRetries`**: `IntFilter` --- **`or_`**: `[WebhookEventsInputFilters]` --- **`requestData`**: `StringFilter` --- **`responseData`**: `StringFilter` --- **`responseReceivedAt`**: `DateTimeFilter` --- **`responseStatusCode`**: `IntFilter` --- **`status`**: `WebhookeventstatusenumFilter` --- **`subscription`**: `WebhookSubscriptionsInputFilters` --- **`subscriptionId`**: `IDFilter` # WebhookHeader Source: https://docs.firstresonance.io/api-reference/types/WebhookHeader The graphene sqlalchemy object type for webhook headers. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_WebhookReceiversCount`**: `Int` Optimized count of webhookReceivers. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`id`**: `Int!` --- **`key`**: `String!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookHeaderEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`value`**: `String!` --- **`webhookReceivers`**: `[WebhookReceiver]` **Arguments:** - `filters`: `WebhookReceiversInputFilters` # WebhookHeaderEventFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookHeaderEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`key`**: `StringFilter` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` # WebhookHeaderEvents Source: https://docs.firstresonance.io/api-reference/types/WebhookHeaderEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `WebhookHeader` --- **`oldValues`**: `WebhookHeader` --- **`timestamp`**: `DateTime` # WebhookHeaderSortEnum Source: https://docs.firstresonance.io/api-reference/types/WebhookHeaderSortEnum **Kind**: `enum` ## Values **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`KEY_ASC`** **`KEY_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`VALUE_ASC`** **`VALUE_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # WebhookHeadersConnection Source: https://docs.firstresonance.io/api-reference/types/WebhookHeadersConnection **Kind**: `object` ## Fields **`edges`**: `[WebhookHeadersEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # WebhookHeadersEdge Source: https://docs.firstresonance.io/api-reference/types/WebhookHeadersEdge A Relay edge containing a `WebhookHeaders` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `WebhookHeader` The item at the end of the edge # WebhookHeadersInputFilters Source: https://docs.firstresonance.io/api-reference/types/WebhookHeadersInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`and_`**: `[WebhookHeadersInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`id`**: `IDFilter` --- **`key`**: `StringFilter` --- **`or_`**: `[WebhookHeadersInputFilters]` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`value`**: `StringFilter` --- **`webhookReceivers`**: `WebhookReceiversInputFilters` # WebhookReceiver Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiver The graphene sqlalchemy object type for webhook receiver. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_HeadersCount`**: `Int` Optimized count of headers. --- **`_SubscriptionsCount`**: `Int` Optimized count of subscriptions. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`active`**: `Boolean` --- **`contentType`**: `Webhookcontenttypesenum` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`description`**: `String` --- **`expectedResponseCode`**: `Int!` --- **`headers`**: `[WebhookHeader]` **Arguments:** - `filters`: `WebhookHeadersInputFilters` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`name`**: `String!` --- **`prettyStr`**: `String` --- **`sharedSecret`**: `String!` --- **`subscriptions`**: `[WebhookSubscription]` **Arguments:** - `filters`: `WebhookSubscriptionsInputFilters` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookReceiverEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id --- **`webhookUri`**: `String!` # WebhookReceiverEventFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiverEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`actor`**: `UserInputFilters` --- **`contentType`**: `WebhookcontenttypesenumFilter` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`eventType`**: `EventTypeFilter` --- **`expectedResponseCode`**: `IntFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`name`**: `StringFilter` --- **`sharedSecret`**: `StringFilter` --- **`updatedById`**: `IDFilter` --- **`webhookUri`**: `StringFilter` # WebhookReceiverEvents Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiverEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `WebhookReceiver` --- **`oldValues`**: `WebhookReceiver` --- **`timestamp`**: `DateTime` # WebhookReceiverHeaderInput Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiverHeaderInput Input which connects webhook receiver to webhook headers. **Kind**: `input` ## Fields **`etag`**: `String!` (required) --- **`webhookHeaderId`**: `Int!` (required) --- **`webhookReceiverId`**: `Int!` (required) # WebhookReceiverSortEnum Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiverSortEnum **Kind**: `enum` ## Values **`CONTENT_TYPE_ASC`** **`CONTENT_TYPE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`DESCRIPTION_ASC`** **`DESCRIPTION_DESC`** **`EXPECTED_RESPONSE_CODE_ASC`** **`EXPECTED_RESPONSE_CODE_DESC`** **`ID_ASC`** **`ID_DESC`** **`NAME_ASC`** **`NAME_DESC`** **`SHARED_SECRET_ASC`** **`SHARED_SECRET_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`WEBHOOK_URI_ASC`** **`WEBHOOK_URI_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # WebhookReceiversConnection Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiversConnection **Kind**: `object` ## Fields **`edges`**: `[WebhookReceiversEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # WebhookReceiversEdge Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiversEdge A Relay edge containing a `WebhookReceivers` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `WebhookReceiver` The item at the end of the edge # WebhookReceiversInputFilters Source: https://docs.firstresonance.io/api-reference/types/WebhookReceiversInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`active`**: `BooleanFilter` --- **`and_`**: `[WebhookReceiversInputFilters]` --- **`contentType`**: `WebhookcontenttypesenumFilter` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`description`**: `StringFilter` --- **`expectedResponseCode`**: `IntFilter` --- **`headers`**: `WebhookHeadersInputFilters` --- **`id`**: `IDFilter` --- **`name`**: `StringFilter` --- **`or_`**: `[WebhookReceiversInputFilters]` --- **`sharedSecret`**: `StringFilter` --- **`subscriptions`**: `WebhookSubscriptionsInputFilters` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` --- **`webhookUri`**: `StringFilter` # WebhookSubscription Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscription The graphene sqlalchemy object type for webhook subscription. **Kind**: `object` ## Fields **`LastSessionId`**: `String` --- **`_EventsCount`**: `Int` Optimized count of events. --- **`_created`**: `DateTime` --- **`_etag`**: `String` --- **`_updated`**: `DateTime` --- **`action`**: `WebhookSubscriptionActions` --- **`active`**: `Boolean!` --- **`createdBy`**: `User` User associated with creating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`createdByApiClient`**: `ApiClientAttribution` --- **`createdById`**: `Int!` User id that created this object. Returns: int of user_id --- **`events`**: `[WebhookEvent]` **Arguments:** - `filters`: `WebhookEventsInputFilters` --- **`id`**: `Int!` --- **`lastUpdatedByApiClient`**: `ApiClientAttribution` --- **`prettyStr`**: `String` --- **`receiver`**: `WebhookReceiver` **Arguments:** - `filters`: `WebhookReceiversInputFilters` --- **`receiverId`**: `Int` --- **`resource`**: `ResourceEnum` --- **`timeline`**: `[Timeline]` > Deprecated: Timeline is deprecated. Use `loggedActions` instead. **Arguments:** - `filters`: `WebhookSubscriptionEventFilter` --- **`updatedBy`**: `User` User associated with updating related attribute. Returns: relationship object **Arguments:** - `filters`: `UserInputFilters` --- **`updatedById`**: `Int!` User id that updated this object. Returns: int of user_id # WebhookSubscriptionActions Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionActions Enum for actions to which a webhook can be subscribed. **Kind**: `enum` ## Values **`CREATE`** **`DELETE`** **`UPDATE`** # WebhookSubscriptionActionsFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionActionsFilter **Kind**: `input` ## Fields **`eq`**: `WebhookSubscriptionActions` --- **`gt`**: `WebhookSubscriptionActions` --- **`gte`**: `WebhookSubscriptionActions` --- **`ilike`**: `WebhookSubscriptionActions` --- **`in`**: `[WebhookSubscriptionActions]` --- **`isnull`**: `Boolean` --- **`like`**: `WebhookSubscriptionActions` --- **`lt`**: `WebhookSubscriptionActions` --- **`lte`**: `WebhookSubscriptionActions` --- **`neq`**: `WebhookSubscriptionActions` --- **`notilike`**: `WebhookSubscriptionActions` --- **`notlike`**: `WebhookSubscriptionActions` # WebhookSubscriptionEventFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionEventFilter **Kind**: `input` ## Fields **`Created`**: `DateTimeFilter` --- **`Updated`**: `DateTimeFilter` --- **`action`**: `WebhookSubscriptionActionsFilter` --- **`active`**: `BooleanFilter` --- **`actor`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`eventType`**: `EventTypeFilter` --- **`id`**: `IDFilter` --- **`includeSelfSimilarRelationships`**: `Boolean` --- **`receiverId`**: `IDFilter` --- **`resource`**: `ResourceEnumFilter` --- **`updatedById`**: `IDFilter` # WebhookSubscriptionEvents Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionEvents **Kind**: `object` ## Implements - `Timeline` ## Fields **`actor`**: `User` --- **`changedAttributes`**: `[ChangedAttributes]` --- **`eventType`**: `EventType` --- **`newValues`**: `WebhookSubscription` --- **`oldValues`**: `WebhookSubscription` --- **`timestamp`**: `DateTime` # WebhookSubscriptionSortEnum Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionSortEnum **Kind**: `enum` ## Values **`ACTION_ASC`** **`ACTION_DESC`** **`ACTIVE_ASC`** **`ACTIVE_DESC`** **`CREATED_BY_ID_ASC`** **`CREATED_BY_ID_DESC`** **`ID_ASC`** **`ID_DESC`** **`RECEIVER_ID_ASC`** **`RECEIVER_ID_DESC`** **`RESOURCE_ASC`** **`RESOURCE_DESC`** **`UPDATED_BY_ID_ASC`** **`UPDATED_BY_ID_DESC`** **`_CREATED_ASC`** **`_CREATED_DESC`** **`_ETAG_ASC`** **`_ETAG_DESC`** **`_LAST_SESSION_ID_ASC`** **`_LAST_SESSION_ID_DESC`** **`_UPDATED_ASC`** **`_UPDATED_DESC`** # WebhookSubscriptionsConnection Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionsConnection **Kind**: `object` ## Fields **`edges`**: `[WebhookSubscriptionsEdge]!` Contains the nodes in this connection. --- **`pageInfo`**: `IonPageInfo!` Pagination data for connection. # WebhookSubscriptionsEdge Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionsEdge A Relay edge containing a `WebhookSubscriptions` and its cursor. **Kind**: `object` ## Fields **`cursor`**: `String!` A cursor for use in pagination --- **`node`**: `WebhookSubscription` The item at the end of the edge # WebhookSubscriptionsInputFilters Source: https://docs.firstresonance.io/api-reference/types/WebhookSubscriptionsInputFilters **Kind**: `input` ## Fields **`_created`**: `DateTimeFilter` --- **`_updated`**: `DateTimeFilter` --- **`action`**: `WebhookSubscriptionActionsFilter` --- **`active`**: `BooleanFilter` --- **`and_`**: `[WebhookSubscriptionsInputFilters]` --- **`createdBy`**: `UserInputFilters` --- **`createdById`**: `IDFilter` --- **`events`**: `WebhookEventsInputFilters` --- **`id`**: `IDFilter` --- **`or_`**: `[WebhookSubscriptionsInputFilters]` --- **`receiver`**: `WebhookReceiversInputFilters` --- **`receiverId`**: `IDFilter` --- **`resource`**: `ResourceEnumFilter` --- **`updatedBy`**: `UserInputFilters` --- **`updatedById`**: `IDFilter` # Webhookcontenttypesenum Source: https://docs.firstresonance.io/api-reference/types/Webhookcontenttypesenum **Kind**: `enum` ## Values **`JSON`** **`XML`** # WebhookcontenttypesenumFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookcontenttypesenumFilter **Kind**: `input` ## Fields **`eq`**: `Webhookcontenttypesenum` --- **`gt`**: `Webhookcontenttypesenum` --- **`gte`**: `Webhookcontenttypesenum` --- **`ilike`**: `Webhookcontenttypesenum` --- **`in`**: `[Webhookcontenttypesenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Webhookcontenttypesenum` --- **`lt`**: `Webhookcontenttypesenum` --- **`lte`**: `Webhookcontenttypesenum` --- **`neq`**: `Webhookcontenttypesenum` --- **`notilike`**: `Webhookcontenttypesenum` --- **`notlike`**: `Webhookcontenttypesenum` # Webhookeventstatusenum Source: https://docs.firstresonance.io/api-reference/types/Webhookeventstatusenum **Kind**: `enum` ## Values **`FAILED`** **`RETRYING`** **`SENDING`** **`SUCCEEDED`** # WebhookeventstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/WebhookeventstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `Webhookeventstatusenum` --- **`gt`**: `Webhookeventstatusenum` --- **`gte`**: `Webhookeventstatusenum` --- **`ilike`**: `Webhookeventstatusenum` --- **`in`**: `[Webhookeventstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `Webhookeventstatusenum` --- **`lt`**: `Webhookeventstatusenum` --- **`lte`**: `Webhookeventstatusenum` --- **`neq`**: `Webhookeventstatusenum` --- **`notilike`**: `Webhookeventstatusenum` --- **`notlike`**: `Webhookeventstatusenum` # _Any Source: https://docs.firstresonance.io/api-reference/types/_Any _Any scalar type **Kind**: `scalar` # _Entity Source: https://docs.firstresonance.io/api-reference/types/_Entity https://www.apollographql.com/docs/apollo-server/federation/federation-spec/#resolve-requests-for-entities To implement the _Entity union, each type annotated with @key should be added to the _Entity union. If no types are annotated with the key directive, then the _Entity union and Query._entities field should be removed from the schema. **Kind**: `union` ## Possible types - `ABomInstallation` - `APIKeyObject` - `ApprovalLevel` - `BarcodeLabel` - `BarcodePattern` - `BarcodePrintRequest` - `BarcodeScanRequest` - `BarcodeTemplate` - `BuildRequirement` - `BuildRequirementReferenceDesignator` - `BuildRequirementSubstitute` - `ChangeOrder` - `ChangeOrderApproval` - `ChangeOrderApprovalRequest` - `ChangeOrderApprovalRole` - `ChargeAccount` - `Comment` - `Contact` - `Currency` - `DatagridColumn` - `DatagridRow` - `DatagridValue` - `EntitiesRequirement` - `FieldHistory` - `FileAttachment` - `FurtherAction` - `FurtherActionApproval` - `FurtherActionApprovalRequest` - `FurtherActionApprovalRole` - `FurtherActionIssue` - `FurtherActionPart` - `FurtherActionRun` - `ImportJob` - `IntentOption` - `Invite` - `Issue` - `IssueApproval` - `IssueApprovalRequest` - `IssueDispositionType` - `IssueDispositionTypeRole` - `IssuePartInventory` - `IssueRelation` - `Label` - `Location` - `LocationSubtype` - `LoggedAction` - `MBom` - `MBomApproval` - `MBomApprovalRequest` - `MBomApprovalRole` - `MBomItem` - `MBomItemReferenceDesignator` - `MBomSubstitute` - `MRPJob` - `MbomChangeOrderLine` - `MbomChangeOrderLineDiff` - `Organization` - `OrganizationDomain` - `Part` - `PartInventory` - `PartInventoryBuildRequirement` - `PartKit` - `PartKitInventory` - `PartKitItem` - `PartProcedure` - `PartSubtype` - `PartUnitOfMeasureConflict` - `PermissionGroup` - `PickOverrideEvent` - `PickRun` - `PickRunStop` - `PickRunStopAllocation` - `Plan` - `PlanConstraint` - `PlanInput` - `PlanItem` - `PlanItemAllocation` - `PlanReservation` - `PrintNodePrinter` - `Procedure` - `ProcedureApproval` - `ProcedureApprovalRequest` - `ProcedureApprovalRole` - `ProcedureMBom` - `ProcedureMBomItem` - `ProcedureReferenceDesignator` - `Project` - `PurchaseOrder` - `PurchaseOrderApproval` - `PurchaseOrderApprovalLevel` - `PurchaseOrderApprovalRequest` - `PurchaseOrderFee` - `PurchaseOrderLine` - `Receipt` - `ReceiptItem` - `Redline` - `RedlineApproval` - `RedlineApprovalRequest` - `RedlineApprovalRole` - `RedlineRoleBasedApproval` - `RedlineRoleBasedApprovalRequest` - `Requirement` - `Review` - `ReviewRequest` - `Role` - `Rule` - `RuleExecutionLog` - `RuleExecutionLogRule` - `Run` - `RunBatch` - `RunStep` - `RunStepBuildRequirement` - `RunStepBuildRequirementSubstitute` - `RunStepField` - `RunStepFieldValidation` - `RunStepsEdge` - `Session` - `SnapshotExportJob` - `Step` - `StepApproval` - `StepApprovalRequest` - `StepApprovalRole` - `StepField` - `StepFieldValidation` - `StepPartRequirement` - `StepProposal` - `StepRoleBasedApproval` - `StepRoleBasedApprovalRequest` - `StepsEdge` - `Supplier` - `SupplierPart` - `Team` - `UnitOfMeasurement` - `User` - `UserDefinedMessage` - `UserNotification` - `UserSubscription` - `ValidationFunction` - `WebhookEvent` - `WebhookHeader` - `WebhookReceiver` - `WebhookSubscription` # _Service Source: https://docs.firstresonance.io/api-reference/types/_Service **Kind**: `object` ## Fields **`sdl`**: `String` # attribute_typesattrtypesenum Source: https://docs.firstresonance.io/api-reference/types/attribute_typesattrtypesenum **Kind**: `enum` ## Values **`BOOLEAN`** **`DATETIME`** **`FILE_ATTACHMENT`** **`ION`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`SLATE_CONTENT`** **`STRING`** # datagrid_typefieldtypes Source: https://docs.firstresonance.io/api-reference/types/datagrid_typefieldtypes **Kind**: `enum` ## Values **`BOOLEAN`** **`DATETIME`** **`FILE_ATTACHMENT`** **`ION`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`SIGNOFF`** **`STRING`** **`TOOL`** # datagrid_typefieldtypesFilter Source: https://docs.firstresonance.io/api-reference/types/datagrid_typefieldtypesFilter **Kind**: `input` ## Fields **`eq`**: `datagrid_typefieldtypes` --- **`gt`**: `datagrid_typefieldtypes` --- **`gte`**: `datagrid_typefieldtypes` --- **`ilike`**: `datagrid_typefieldtypes` --- **`in`**: `[datagrid_typefieldtypes]` --- **`isnull`**: `Boolean` --- **`like`**: `datagrid_typefieldtypes` --- **`lt`**: `datagrid_typefieldtypes` --- **`lte`**: `datagrid_typefieldtypes` --- **`neq`**: `datagrid_typefieldtypes` --- **`notilike`**: `datagrid_typefieldtypes` --- **`notlike`**: `datagrid_typefieldtypes` # datagridiontypeentitytypeenum Source: https://docs.firstresonance.io/api-reference/types/datagridiontypeentitytypeenum **Kind**: `enum` ## Values **`LOCATIONS`** **`PARTS`** **`PROJECTS`** **`USERS`** # datagridiontypeentitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/datagridiontypeentitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `datagridiontypeentitytypeenum` --- **`gt`**: `datagridiontypeentitytypeenum` --- **`gte`**: `datagridiontypeentitytypeenum` --- **`ilike`**: `datagridiontypeentitytypeenum` --- **`in`**: `[datagridiontypeentitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `datagridiontypeentitytypeenum` --- **`lt`**: `datagridiontypeentitytypeenum` --- **`lte`**: `datagridiontypeentitytypeenum` --- **`neq`**: `datagridiontypeentitytypeenum` --- **`notilike`**: `datagridiontypeentitytypeenum` --- **`notlike`**: `datagridiontypeentitytypeenum` # extensibleattributecriticalityenum Source: https://docs.firstresonance.io/api-reference/types/extensibleattributecriticalityenum **Kind**: `enum` ## Values **`CRITICAL`** **`NON_CRITICAL`** # extensibleattributecriticalityenumFilter Source: https://docs.firstresonance.io/api-reference/types/extensibleattributecriticalityenumFilter **Kind**: `input` ## Fields **`eq`**: `extensibleattributecriticalityenum` --- **`gt`**: `extensibleattributecriticalityenum` --- **`gte`**: `extensibleattributecriticalityenum` --- **`ilike`**: `extensibleattributecriticalityenum` --- **`in`**: `[extensibleattributecriticalityenum]` --- **`isnull`**: `Boolean` --- **`like`**: `extensibleattributecriticalityenum` --- **`lt`**: `extensibleattributecriticalityenum` --- **`lte`**: `extensibleattributecriticalityenum` --- **`neq`**: `extensibleattributecriticalityenum` --- **`notilike`**: `extensibleattributecriticalityenum` --- **`notlike`**: `extensibleattributecriticalityenum` # gateTypeissueapprovalgatetypeenum Source: https://docs.firstresonance.io/api-reference/types/gateTypeissueapprovalgatetypeenum **Kind**: `enum` ## Values **`IN_PROGRESS`** **`RESOLVED`** # organizationiontypeentitytypeenum Source: https://docs.firstresonance.io/api-reference/types/organizationiontypeentitytypeenum **Kind**: `enum` ## Values **`LOCATIONS`** **`PARTS`** **`PROJECTS`** **`USERS`** # organizationiontypeentitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/organizationiontypeentitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `organizationiontypeentitytypeenum` --- **`gt`**: `organizationiontypeentitytypeenum` --- **`gte`**: `organizationiontypeentitytypeenum` --- **`ilike`**: `organizationiontypeentitytypeenum` --- **`in`**: `[organizationiontypeentitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `organizationiontypeentitytypeenum` --- **`lt`**: `organizationiontypeentitytypeenum` --- **`lte`**: `organizationiontypeentitytypeenum` --- **`neq`**: `organizationiontypeentitytypeenum` --- **`notilike`**: `organizationiontypeentitytypeenum` --- **`notlike`**: `organizationiontypeentitytypeenum` # partprocedurestatusreviewstatusenum Source: https://docs.firstresonance.io/api-reference/types/partprocedurestatusreviewstatusenum **Kind**: `enum` ## Values **`APPROVED`** **`PENDING`** **`REJECTED`** # partprocedurestatusreviewstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/partprocedurestatusreviewstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `partprocedurestatusreviewstatusenum` --- **`gt`**: `partprocedurestatusreviewstatusenum` --- **`gte`**: `partprocedurestatusreviewstatusenum` --- **`ilike`**: `partprocedurestatusreviewstatusenum` --- **`in`**: `[partprocedurestatusreviewstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `partprocedurestatusreviewstatusenum` --- **`lt`**: `partprocedurestatusreviewstatusenum` --- **`lte`**: `partprocedurestatusreviewstatusenum` --- **`neq`**: `partprocedurestatusreviewstatusenum` --- **`notilike`**: `partprocedurestatusreviewstatusenum` --- **`notlike`**: `partprocedurestatusreviewstatusenum` # partstatusenumpartstatusenum Source: https://docs.firstresonance.io/api-reference/types/partstatusenumpartstatusenum **Kind**: `enum` ## Values **`ARCHIVED`** **`RELEASED`** # purchasetypeenum Source: https://docs.firstresonance.io/api-reference/types/purchasetypeenum **Kind**: `enum` ## Values **`NON_RECEIVABLE_NON_INVENTORY`** **`RECEIVABLE_INVENTORY`** **`RECEIVABLE_NON_INVENTORY`** # purchasetypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/purchasetypeenumFilter **Kind**: `input` ## Fields **`eq`**: `purchasetypeenum` --- **`gt`**: `purchasetypeenum` --- **`gte`**: `purchasetypeenum` --- **`ilike`**: `purchasetypeenum` --- **`in`**: `[purchasetypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `purchasetypeenum` --- **`lt`**: `purchasetypeenum` --- **`lte`**: `purchasetypeenum` --- **`neq`**: `purchasetypeenum` --- **`notilike`**: `purchasetypeenum` --- **`notlike`**: `purchasetypeenum` # reviewattrtypesenum Source: https://docs.firstresonance.io/api-reference/types/reviewattrtypesenum **Kind**: `enum` ## Values **`BOOLEAN`** **`DATETIME`** **`FILE_ATTACHMENT`** **`ION`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`SLATE_CONTENT`** **`STRING`** # reviewattrtypesenumFilter Source: https://docs.firstresonance.io/api-reference/types/reviewattrtypesenumFilter **Kind**: `input` ## Fields **`eq`**: `reviewattrtypesenum` --- **`gt`**: `reviewattrtypesenum` --- **`gte`**: `reviewattrtypesenum` --- **`ilike`**: `reviewattrtypesenum` --- **`in`**: `[reviewattrtypesenum]` --- **`isnull`**: `Boolean` --- **`like`**: `reviewattrtypesenum` --- **`lt`**: `reviewattrtypesenum` --- **`lte`**: `reviewattrtypesenum` --- **`neq`**: `reviewattrtypesenum` --- **`notilike`**: `reviewattrtypesenum` --- **`notlike`**: `reviewattrtypesenum` # reviewreviewstatusenum Source: https://docs.firstresonance.io/api-reference/types/reviewreviewstatusenum **Kind**: `enum` ## Values **`APPROVED`** **`PENDING`** **`REJECTED`** # reviewreviewstatusenumFilter Source: https://docs.firstresonance.io/api-reference/types/reviewreviewstatusenumFilter **Kind**: `input` ## Fields **`eq`**: `reviewreviewstatusenum` --- **`gt`**: `reviewreviewstatusenum` --- **`gte`**: `reviewreviewstatusenum` --- **`ilike`**: `reviewreviewstatusenum` --- **`in`**: `[reviewreviewstatusenum]` --- **`isnull`**: `Boolean` --- **`like`**: `reviewreviewstatusenum` --- **`lt`**: `reviewreviewstatusenum` --- **`lte`**: `reviewreviewstatusenum` --- **`neq`**: `reviewreviewstatusenum` --- **`notilike`**: `reviewreviewstatusenum` --- **`notlike`**: `reviewreviewstatusenum` # runstepfieldfieldtypes Source: https://docs.firstresonance.io/api-reference/types/runstepfieldfieldtypes **Kind**: `enum` ## Values **`BOOLEAN`** **`DATETIME`** **`FILE_ATTACHMENT`** **`ION`** **`MULTISELECT`** **`NUMBER`** **`SELECT`** **`SIGNOFF`** **`STRING`** **`TOOL`** # runstepfieldfieldtypesFilter Source: https://docs.firstresonance.io/api-reference/types/runstepfieldfieldtypesFilter **Kind**: `input` ## Fields **`eq`**: `runstepfieldfieldtypes` --- **`gt`**: `runstepfieldfieldtypes` --- **`gte`**: `runstepfieldfieldtypes` --- **`ilike`**: `runstepfieldfieldtypes` --- **`in`**: `[runstepfieldfieldtypes]` --- **`isnull`**: `Boolean` --- **`like`**: `runstepfieldfieldtypes` --- **`lt`**: `runstepfieldfieldtypes` --- **`lte`**: `runstepfieldfieldtypes` --- **`neq`**: `runstepfieldfieldtypes` --- **`notilike`**: `runstepfieldfieldtypes` --- **`notlike`**: `runstepfieldfieldtypes` # runstepfieldiontypeentitytypeenum Source: https://docs.firstresonance.io/api-reference/types/runstepfieldiontypeentitytypeenum **Kind**: `enum` ## Values **`LOCATIONS`** **`PARTS`** **`PROJECTS`** **`USERS`** # runstepfieldiontypeentitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/runstepfieldiontypeentitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `runstepfieldiontypeentitytypeenum` --- **`gt`**: `runstepfieldiontypeentitytypeenum` --- **`gte`**: `runstepfieldiontypeentitytypeenum` --- **`ilike`**: `runstepfieldiontypeentitytypeenum` --- **`in`**: `[runstepfieldiontypeentitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `runstepfieldiontypeentitytypeenum` --- **`lt`**: `runstepfieldiontypeentitytypeenum` --- **`lte`**: `runstepfieldiontypeentitytypeenum` --- **`neq`**: `runstepfieldiontypeentitytypeenum` --- **`notilike`**: `runstepfieldiontypeentitytypeenum` --- **`notlike`**: `runstepfieldiontypeentitytypeenum` # runstepsteptypes Source: https://docs.firstresonance.io/api-reference/types/runstepsteptypes **Kind**: `enum` ## Values **`CONTENT`** **`DATAGRID`** # runstepsteptypesFilter Source: https://docs.firstresonance.io/api-reference/types/runstepsteptypesFilter **Kind**: `input` ## Fields **`eq`**: `runstepsteptypes` --- **`gt`**: `runstepsteptypes` --- **`gte`**: `runstepsteptypes` --- **`ilike`**: `runstepsteptypes` --- **`in`**: `[runstepsteptypes]` --- **`isnull`**: `Boolean` --- **`like`**: `runstepsteptypes` --- **`lt`**: `runstepsteptypes` --- **`lte`**: `runstepsteptypes` --- **`neq`**: `runstepsteptypes` --- **`notilike`**: `runstepsteptypes` --- **`notlike`**: `runstepsteptypes` # stepfieldiontypeentitytypeenum Source: https://docs.firstresonance.io/api-reference/types/stepfieldiontypeentitytypeenum **Kind**: `enum` ## Values **`LOCATIONS`** **`PARTS`** **`PROJECTS`** **`USERS`** # stepfieldiontypeentitytypeenumFilter Source: https://docs.firstresonance.io/api-reference/types/stepfieldiontypeentitytypeenumFilter **Kind**: `input` ## Fields **`eq`**: `stepfieldiontypeentitytypeenum` --- **`gt`**: `stepfieldiontypeentitytypeenum` --- **`gte`**: `stepfieldiontypeentitytypeenum` --- **`ilike`**: `stepfieldiontypeentitytypeenum` --- **`in`**: `[stepfieldiontypeentitytypeenum]` --- **`isnull`**: `Boolean` --- **`like`**: `stepfieldiontypeentitytypeenum` --- **`lt`**: `stepfieldiontypeentitytypeenum` --- **`lte`**: `stepfieldiontypeentitytypeenum` --- **`neq`**: `stepfieldiontypeentitytypeenum` --- **`notilike`**: `stepfieldiontypeentitytypeenum` --- **`notlike`**: `stepfieldiontypeentitytypeenum` # Migrate to the new aBOM API Source: https://docs.firstresonance.io/api/abom-actions-for-developers Update API, ION Actions, webhooks, and SQL from the legacy AbomItems model to BuildRequirements and AbomInstallations. ## Actions needed This project will introduce breaking changes. 1. **API**: If you are using the API to call any of the below mutations or a query that uses any of the below fields, you will need to update your mutations/queries. 2. **Actions**: If you have any ION actions (rules) using any of the objects below, those will be disabled when this project is released and you will need to update those after release. 3. **Webhooks**: If you have any webhooks listening to any of the objects below, you will need to update your webhook listeners after release. 4. **Analytics**: If you have any SQL queries referencing `abom_items` or `abom_edges` those will need to be updated. ## Changes overview Below shows an example of a car assembly that is partially installed and the differences between the old structure and the new structure. Old structure: ```mermaid fullWidth="false" theme={null} graph TB i1([ inventory 1 car assembly SN 45 ]) i2([ inventory 2 SN 12 ]) i3([ inventory 3 SN 13 ]) ab1[ abom item 1 car assembly qty 1 ] ab2[ abom item 2 wheel assembly qty 1 ] ab3[ abom item 3 wheel assembly qty 1 ] ab4[ abom item 4 wheel assembly qty 2 ] ab5[ abom item 5 fastener qty 50 ] i1 --- ab1 ab1 ---> ab2 ab1 ---> ab3 ab1 ---> ab4 ab1 ---> ab5 ab2 --- i2 ab3 --- i3 classDef green fill:#9f6,stroke:#333,stroke-width:2px; class i1,i2,i3 green ``` New structure: ```mermaid fullWidth="false" theme={null} graph TB i1([ inventory 1 car assembly SN 45 ]) i2([ inventory 2 SN 12 ]) i3([ inventory 3 SN 13 ]) br1[ build requirement 1 wheel assembly qty 4 ] br2[ build requirement 2 fastener qty 50 ] i1 ---> br1 i1 ---> br2 br1 --abom installation--- i2 br1 --abom installation--- i3 classDef green fill:#9f6,stroke:#333,stroke-width:2px; class i1,i2,i3 green ``` Old structure: * aBOM items represent both the requirement and fulfillment of the installation * aBOM items are used to link to inventories * aBOM edges connect aBOM items * aBOM items change as items are partially installed/removed. New ones get created or deleted, or quantities change New structure: * Build requirements belong to parent inventories and represent what needs to be installed * Build requirements do not change as items are installed into them * aBOM installations link inventories to a build requirement. The addition of an aBOM installation is an install. The removal of an aBOM installation is an uninstall ## Mutation/query changes * AbomItems will be replaced by `BuildRequirements` and `AbomInstallations`, where the requirement and fulfillment (install) are clearly delineated * AbomEdges will be replaced by `PartInventoryBuildRequirements` ### Going away #### Mutations * `InstallKitOnAbomItemChildren` * `CreateAbomItem` * `DeleteAbomItem` * `UpdateAbomItem` #### GQL Objects/Queries * `AbomItems` * `ABomEdges` * `ABomItemReferenceDesignators` #### Fields * `PartInventory.abomItems` * `PartInventory.abomChildren` * `PartInventory.abomParents` * `PartInventory.allChildren` * `PartInventory.allParents` * `Part.abomItems` * `MBomItem.abomItems` * `MBomItemReferenceDesignator.abomItems` * `AbomItemReferenceDesignator.abomItem` (and any count fields generated from these relationships)\ ### Examples #### API: Installing a part Old structure: Previously, you would have to update an existing `abom_item` with an inventory to install that inventory. The `abom_item` at that point may get swapped if the inventory being installed is already linked ot an `abom_item` > [tab] Update aBOM item > > ```graphql theme={null} > mutation UpdateABomItem($input: UpdateABomItemInput!) { > updateAbomItem(input: $input) { > abomItem { > id updatedById partInventoryId > } > } > } > ``` > [tab] Inputs > > ```graphql theme={null} > { > "input": { > "id": 1, > "partInventoryId": 1, > "etag": "etag" > } > } > ``` New structure: Now installing a part is done via creating an aBOM installation. aBOM installations link inventories to `buildRequirements`. Uninstalling a part is done by deleting aBOM installations. > [tab] Create aBOM installation > > ```graphql theme={null} > mutation CreateABomInstallation($input: CreateABomInstallationInput!) { > createAbomInstallation(input: $input) { > abomInstallation { > buildRequirementId > buildRequirementReferenceDesignatorId > partInventoryId > quantity > } > } > } > ``` > [tab] Inputs > > ```graphql theme={null} > { > "input": { > "buildRequirementId": 1, > "partInventoryId": 3, > "quantity": 1 > } > } > > ``` #### SQL: Query for an inventory's aBOM Old structure: ```sql theme={null} select parent_part.part_number, parent_part.description, parent_inventory.serial_number, parent_inventory.lot_number, parent_inventory.quantity, child_part.part_number, child_part.description, child_inventory.serial_number, child_inventory.lot_number, child_abom_item.quantity as 'installed quantity' from parts_inventory parent_inventory inner join parts parent_part on parent_part.id = parent_inventory.part_id inner join abom_items parent_abom_item on parent_inventory.id = ai.part_inventory_id inner join abom_edges ae on ae.parent_abom_item_id = parent_abom_item.id inner join abom_items child_abom_item on child_abom_item.id = ae.child_abom_item_id inner join parts_inventory child_inventory on child_abom_item.part_inventory_id = child_inventory.id inner join parts child_part on child_part.id = child_abom_item.part_id where parent_inventory.id = 105 ``` New structure: ```sql theme={null} select parent_part.part_number, parent_part.description, parent_inventory.serial_number, parent_inventory.lot_number, parent_inventory.quantity, child_part.part_number, child_part.description, child_inventory.serial_number, child_inventory.lot_number, ai.quantity as 'installed quantity' from parts_inventory parent_inventory inner join parts parent_part on parent_part.id = parent_inventory.part_id inner join part_inventory_build_requirements pibr on pibr.part_inventory_id = parent_inventory.id inner join abom_installations ai on pibr.build_requirement_id = ai.build_requirement_id inner join parts_inventory child_inventory on ai.part_inventory_id = child_inventory.id inner join parts child_part on child_part.id = child_abom_item.part_id where parent_inventory.id = 105 ``` # Manage API keys Source: https://docs.firstresonance.io/api/authentication/api-keys Create, use, list, rotate, disable, and delete ION API keys for machine-to-machine integrations. API keys authenticate machine-to-machine integrations. These include scripts, automations, ETL jobs, MES bridges, IoT devices, and other systems that call ION without a person signing in. You create, manage, and delete them through the API or the UI. For user-facing applications where ION enforces a specific user's permissions, use [OAuth 2.0](/api/authentication/oauth) instead. ## How API keys behave * Each API key is **specific to the environment** it was generated in. A key created in production will not work in sandbox. * A key holds the **same permissions the creating user had at the moment it was generated**. Later changes to that user's permissions do not affect the key. * Generating a new key does **not** invalidate previously generated keys. They keep working until disabled. * Any automation using a key **acts on behalf of the user who created it**. * A key is **automatically disabled when its user is deactivated**. > [!NOTE] > > You need the `APIKeyObject` family of permissions to work with API keys. See > the [permissions > reference](/administration/users-and-permissions#permissions-reference) for > details. > [!WARNING] > > For automations and integrations, back the key with a [service > account](#service-accounts) rather than an individual's user. ## Create a key An org admin provisions API keys. Each key is bound to a user identity in your organization. Audit logs then reflect which integration made each call. To create a key in ION: 1. In ION, go to **Settings > Organization > API Keys**. 2. Click **New API key**. 3. Enter a **Name**, and optionally a **Description**, then click **Create**. 4. Copy the **Client ID** and **Client secret**, then click **Done**. To create a key with the API, run this mutation: ```graphql theme={null} mutation CreateAPIKey { createApiKey { apikey { clientId clientSecret } } } ``` Either way, the client secret is shown **once**. Capture it immediately and store it in a secrets manager such as AWS Secrets Manager, HashiCorp Vault, 1Password, or your CI/CD's encrypted secrets store. ION cannot retrieve a secret after creation. ## Get an access token A key's `clientId` and `clientSecret` exchange for a short-lived access token through the client-credentials grant. ION then accepts that token on the `Authorization` header. Most integrations use a small client library that handles the exchange and caching for you. See the [Build an API client](/api/guides/python-quickstart) for a runnable example. To exchange the credentials directly, POST a `client_credentials` grant to the auth server for your environment: ```bash theme={null} curl -X POST \ --data-urlencode "grant_type=client_credentials" \ -d "client_id=CLIENT_ID" \ -d "client_secret=CLIENT_SECRET" \ https:///realms/api-keys/protocol/openid-connect/token ``` The auth server and API endpoint differ per environment. For both, see [ION environments](/getting-started/ion-basics#ion-environments). For more runnable scripts, see the [ion-examples repository](https://github.com/FirstResonance/ion-examples). ## List keys ```graphql theme={null} query APIKeys { apiKeys { edges { node { clientId clientSecret id _etag } } } } ``` ## Enable, disable, or regenerate a secret Update a key with this mutation: ```graphql theme={null} mutation UpdateAPIKey($input: APIKeyInput!) { updateApiKey(input: $input) { apikey { clientId clientSecret enabled } } } ``` Set the variables: ```json theme={null} { "input": { "clientId": "", "_etag": "", "enabled": true, "regenerateSecret": false } } ``` Set `enabled` to `false` to disable a key. Set `regenerateSecret` to `true` to rotate its secret. Disabling takes effect immediately. The next request using that key returns `401 Unauthorized`. ## Rotate a key Rotate an API key when: * The key might have been exposed, such as being committed to a public repo, leaked in logs, or held by an employee who has left. * Your org's security policy requires periodic rotation. * An integration is being decommissioned. Rotate with zero downtime: 1. Provision a new key alongside the existing one. 2. Deploy the new key to the integration and verify traffic is succeeding with it. 3. Delete the old key. Both keys stay valid until you delete the old one, so consumers see no auth failures. ## Delete a key ```graphql theme={null} mutation DeleteAPIKey($input: APIKeyInput!) { deleteApiKey(input: $input) { apikey { clientId } } } ``` Set the variables: ```json theme={null} { "input": { "clientId": "", "_etag": "" } } ``` Deletion is immediate. The next request using that key returns `401 Unauthorized`. ## Service accounts Service accounts decouple API keys from individual users who might get deactivated. They also make clear that the actions in ION come from a shared service rather than from one person. A service account is an email your company creates and maintains outside of any employee's email. Multiple people can access it as needed. # Authentication Source: https://docs.firstresonance.io/api/authentication/index How to authenticate against the ION GraphQL API: API keys for machine-to-machine integrations and OAuth 2.0 for user-facing applications. ## Authentication methods The ION GraphQL API supports two authentication methods: **API keys** for machine-to-machine integrations and **OAuth 2.0** for user-facing applications. Both methods use your region's API endpoint and the same `Authorization` header. Only the way you obtain the token differs. ## Endpoint and headers Include the access token on every request. `Host` is your region's API endpoint. For the endpoint that matches your app URL, see [Getting started](/getting-started/ion-basics#ion-environments). ```http theme={null} POST /graphql HTTP/1.1 Host: api.buildwithion.com Authorization: Bearer Content-Type: application/json ``` ION also accepts `Authorization: Token ` for backward compatibility. Prefer `Bearer`. For multipart file uploads, set `Content-Type: multipart/form-data`. Follow the flow in [File Upload](/api/guides/file-upload). ## Troubleshooting When ION rejects a request during authentication, the response carries an `errors[].message` payload: ```json theme={null} { "errors": [{ "message": "Token is expired." }] } ``` For the full list of authentication failures and their fixes (`401 Unauthorized`, `403 Forbidden`, rate limits, and `5xx` errors), see [Error codes](/api/error-codes). # Authenticate with OAuth 2.0 Source: https://docs.firstresonance.io/api/authentication/oauth Register an OAuth application, run the authorization code flow, and handle token refresh and scopes for user-facing apps on ION. Use OAuth 2.0 when the caller is a user-facing application, such as a web app, desktop tool, or mobile client. OAuth lets ION enforce that user's permissions rather than a service account's. For system-to-system integrations, use an [API key](/api/authentication/api-keys) instead. ## Register an OAuth application Before users can sign in to your application, an org admin must register the application with ION. Run this mutation to register it: ```graphql theme={null} mutation RegisterApp { registerOauthApp(name: "Acme Production Dashboard", appType: "regular_web") { oauthApp { id clientId } } } ``` After registration, configure callback URLs, allowed origins, and logout URLs: ```graphql theme={null} mutation AddCallback { addOauthRedirectUri( oauthAppId: 42 uri: "https://app.example.com/auth/callback" uriType: "callback" ) { redirectUri { id uri uriType } } } ``` Three URI types are supported: | URI type | Purpose | | - | - | | `callback` | Where ION redirects users with the authorization code after they sign in | | `origin` | Browser origins allowed to make authenticated requests | | `logout` | Where ION redirects users after sign-out | Register every URL your application uses (production, staging, local development) to avoid `redirect_uri` mismatches. ## Run the authorization code flow Follow the standard OAuth 2.0 authorization code flow: 1. **Redirect the user to the ION authorization endpoint.** Include `client_id`, `redirect_uri`, `response_type=code`, `scope`, and `state`. 2. The user authenticates with their ION credentials or SSO. 3. ION redirects to your `redirect_uri` with an authorization `code` and the `state` you sent. 4. **Exchange the code** at the token endpoint for an `access_token`, and optionally a `refresh_token`. 5. **Use the access token** on subsequent API calls. The authorization and token endpoint URLs depend on your org's auth provider configuration. ION surfaces them in the OAuth app registration response. If you're integrating against ION for the first time, ask your CSM for the endpoint values that match your environment. ## Handle token expiration and refresh Access tokens have a short lifetime, typically one hour. Two patterns handle expiration: * **Short-lived integrations.** Let the token expire. Re-run the auth flow the next time the user opens the app. * **Long-lived integrations.** Request the `offline_access` scope at authorization. Then exchange refresh tokens for new access tokens transparently. Always re-validate tokens before relying on them. Clock skew, server-side revocation, or org membership changes can invalidate a token mid-flight. ## Scopes Scopes constrain what an OAuth-issued token can do. Standard scopes include the following: | Scope | Allows | | - | - | | `openid` | Receive an ID token alongside the access token | | `profile` | Read the user's profile | | `email` | Read the user's email | | `offline_access` | Receive a refresh token | ION applies the user's existing role and permission grants on top of the scope. A scope cannot grant a user more access than their role allows. # Data model Source: https://docs.firstresonance.io/api/data-model How ION's core entities relate to each other and how they map to terminology in adjacent systems (ERP, MES, PLM, QMS). ## Overview When you integrate against ION, a small set of core entities covers most of what you touch. Each entity below shows what it represents, how it connects to the others, and what it maps to in adjacent systems such as ERP, MES, PLM, and QMS. For every query, mutation, and type, see the [API Reference](/api-reference/overview). To run queries, use the [API Playground](/api/playground). ## Entity map The core entities connect through these relationships: ```mermaid theme={null} flowchart TD PartSubtype["PartSubtype (categorization, many-to-many)"] Part["Part (library item, design intent)"] PartInventory["PartInventory (stockable or serialized unit)"] Procedure["Procedure (template)"] PurchaseOrder["PurchaseOrder line items"] Run["Run (execution)"] RunBatch["RunBatch (batched runs)"] RunStep["RunStep"] BuildRequirement["BuildRequirement (aBOM line item)"] Issue["Issue (quality event)"] PartSubtype -->|tags| Part Part -->|instances of| PartInventory PartInventory --> Procedure PartInventory --> PurchaseOrder Procedure -->|template for| Run RunBatch --> Run Run --> RunStep RunStep --> BuildRequirement RunStep --> Issue ``` ## Parts A **Part** is the library entry. It holds a part number, description, revision, and the design intent. A Part is not the physical thing on the shelf. That physical thing is a `PartInventory`. | Field | Notes | | - | - | | `id`, `partNumber` | Org-unique within `revision`. `partNumber` is your SKU. | | `description` | Free text. | | `revision` | Engineering revision letter or string. | | `partType` | `PART` or `TOOL`. | | `trackingType` | `SERIAL`, `LOT`, or unset (untracked). | | `status` | `RELEASED` or `ARCHIVED`. | | `sourcingStrategy` | `MAKE`, `BUY`, or `DUAL_SOURCE`. | | `purchaseType` | `RECEIVABLE_INVENTORY`, `RECEIVABLE_NON_INVENTORY`, or `NON_RECEIVABLE_NON_INVENTORY`. | | `partSubtypes` | Many-to-many with `PartSubtype`. These are categorization tags. | | `cost`, `leadTime` | Optional planning fields. | | `revisedFromId` | Links this revision to its predecessor. | Query a part: ```graphql theme={null} query GetPart { part(id: "42") { id partNumber description revision partType trackingType status partSubtypes { id name } } } ``` **Maps to:** "SKU" or "Item Master" in ERP. "PartNumber" in PLM. ## PartSubtype A **PartSubtype** is a categorization tag attached to a Part. Subtypes group parts that share routing, inspection, or planning behavior. Examples include "Mounting hardware", "Critical-to-quality fasteners", and "Long-lead-time stock". A part can have multiple subtypes. Query the subtypes: ```graphql theme={null} query Subtypes { partSubtypes(first: 50) { edges { node { id name description } } } } ``` **Maps to:** "Item Family", "Commodity Code", or "Product Line" in ERP. Don't confuse a subtype with revision lineage. Revision lineage is `revisedFromId` on Part. ## PartInventory A **PartInventory** is a physical instance of a Part. It can be a serialized unit, a lot, or a quantity at a location. This is the entity that gets installed onto assemblies, consumed in runs, or shipped. | Field | Notes | | - | - | | `serialNumber` | If the part is serialized. | | `lotNumber` | If the part is lot-tracked. | | `quantity` | For non-serialized inventory (count). | | `status` | Such as `AVAILABLE`, `WIP`, `KITTED`, `INSTALLED`, `ON_ORDER`, `SCRAPPED`, or `UNAVAILABLE`. | | `part` | Reference to its `Part`. | | `location` | Where it physically lives. | | `madeOnAssemblyParentPartInventory` | If installed onto an assembly, points up the build tree. | | `entity` | Polymorphic id used for file attachments and similar. | Query a part inventory record: ```graphql theme={null} query Inventory { partInventory(id: "9876") { id serialNumber lotNumber quantity status part { id partNumber description } location { id name } madeOnAssemblyParentPartInventory { id serialNumber } } } ``` **Maps to:** "Serial" or "Lot" in MES. "Inventory unit" or "Stockable item" in WMS. "Asset" in PLM. ## Assemblies (as-built BOM) An **as-built BOM** is the parent and child tree of `PartInventory` units that compose a finished assembly. ION represents this tree two ways. The `madeOnAssemblyParentPartInventory` reference on each PartInventory points up the tree. The `BuildRequirement` records define which parts to install where to complete the assembly. To traverse the tree downward: ```graphql theme={null} query AbomTree { partInventory(id: "9876") { id serialNumber part { partNumber } buildRequirements { id part { partNumber } quantity abomInstallations { id partInventory { id serialNumber part { partNumber } } } } } } ``` To walk up the tree, follow `madeOnAssemblyParentPartInventory` recursively. **Maps to:** "Bill of Materials" in ERP. "Assembly tree" in PLM. "Bill of Build" in MES. > [!NOTE] > > The `mBOM` (manufacturing BOM) is the planned structure. The `aBOM` (as-built) is what was actually installed at run time. Both have GraphQL types in ION. ## Procedures and run steps A **Procedure** is the manufacturing routing template. It defines what should happen on the floor. A Procedure is composed of steps. Query a procedure with its steps: ```graphql theme={null} query Proc { procedure(id: "12") { id title version steps { id title position type fields { id name type } } } } ``` **Maps to:** "Routing" in ERP. "Recipe" or "Standard Operating Procedure" in MES. "Work Instruction" in QMS. ## Runs and run steps A **Run** is one execution of a Procedure against a specific PartInventory. **Run steps** are the per-execution instances of the procedure's steps. A run step is where operators record measurements, sign off, and report quality issues. | Field | Notes | | - | - | | `id`, `title` | | | `status` | Such as `TODO`, `IN_PROGRESS`, or `COMPLETE`. | | `procedure` | Template. | | `partInventory` | What's being built. | | `steps` | Ordered execution instances (`RunStep`). | | `runBatch` | If the run participates in a batch, see [Run batches](/build-hardware/runs-and-execution/run-batches). | Query a run with its steps: ```graphql theme={null} query GetRun { run(id: "1234") { id title status procedure { id title version } partInventory { id serialNumber part { partNumber } } steps { id position status endTime fields { id name value } } } } ``` **Maps to:** "Work Order" in ERP. "Production Order" in MES. "Build" or "Job" colloquially. ## Build requirements A **BuildRequirement** is a line item on an aBOM. It defines how many of a given part to install to complete the assembly. Operators install against build requirements during a run. Each install is a row of `abomInstallations` (an `ABomInstallation`) that links the `PartInventory` consumed to the build requirement satisfied. For the user-facing flow, see [Editing build requirements](/build-hardware/bills-of-materials/editing-build-requirements). ## Issues An **Issue** is a quality event. It can be a nonconformance, deviation, supplier problem, or observation. Issues attach to runs, run steps, or part inventories. Issues follow a defined lifecycle. The states are Pending, In Progress, In Review, and Resolved. Disposition types determine what happens to the affected inventory. Query open issues by disposition: ```graphql theme={null} query OpenIssues { issues(filters: { status: { eq: IN_PROGRESS } }) { edges { node { id title status issueDispositionType { id title } assignedTo { id name } runStep { id } } } } } ``` For more information, see [Issue states, dispositions, and resolutions](/track-quality/issues). **Maps to:** "Nonconformance Report" (NCR) in QMS. "CAPA" precursor in QMS. "Defect" in PLM. "Incident" in ServiceNow-style systems. ## Purchase orders For supply chain integrations: ```graphql theme={null} query OpenPOs { purchaseOrders(filters: { isOpen: { eq: true } }) { edges { node { id prettyStr status supplier { id name } purchaseOrderLines { id part { partNumber } quantity receivedQuantity } } } } } ``` **Maps to:** "PO" in ERP. Receiving against a PO updates `PartInventory` records. ## File attachments Files attach to entities polymorphically through the `entity` ID. For the upload flow and the `entity { id }` lookup pattern, see [File upload](/api/guides/file-upload). ## The `entity` polymorphic ID ION gives every attachable object a uniform ID through an `entities` reference. Most major entities expose an `entity { id }` field. This field is the target for several features: * File attachments * Subscriptions (notifications) * Comments * Cross-entity links, such as an issue to a run step Don't confuse this field with the entity's own `id`. When an integration calls for an `entityId`, fetch the parent's `entity.id` first. ## Field-mapping cheat sheet When you bridge from another system, use this rough translation: | Your system says… | ION calls it… | | - | - | | SKU, Item Master, or Part Number | `Part.partNumber` | | Item Family, Commodity, or Group | `PartSubtype.name` (a part can belong to multiple subtypes) | | Lot or Batch number | `PartInventory.lotNumber` | | Serial or Asset Tag | `PartInventory.serialNumber` | | On-hand quantity | `PartInventory.quantity` | | BOM line item | `BuildRequirement` | | Work Order or Production Order | `Run` | | Routing, Recipe, or Process | `Procedure` | | Operation, Step, or Op | `Step` (template) or `RunStep` (execution) | | NCR or Nonconformance | `Issue` | | Disposition (Use As Is, Rework, Scrap) | `IssueDispositionType` | | PO | `PurchaseOrder` | | PO line | `PurchaseOrderLine` | | Vendor or Supplier | `PurchaseOrder.supplier` (a `Supplier`) | | Workcenter or Cell | `Location` (typed `WORKCENTER`) | | Tote, Bin, or Rack | `Location` (other types) | | User group or Role | `Role` | | User | `User` | | Tenant or Org | `Organization` | ## Etag-based concurrency Every mutable entity returns an `_etag` on read. Pass it back on `update` and `delete` mutations. ION rejects writes whose etag doesn't match the current value. A mismatch returns a 409. For more information, see [Error codes 409](/api/error-codes#409-concurrency-conflict). When you integrate, read then write inside a short window. Propagate the etag through your service. ## Discovering the rest of the schema In addition to the [API Reference](/api-reference/overview) and the API Playground, you can use `__schema` introspection for programmatic access. # Error codes Source: https://docs.firstresonance.io/api/error-codes HTTP status codes and GraphQL error payloads ION returns: what each one means, what causes it, and how to fix it. ## Overview When an ION API request fails, two things tell you what went wrong. The HTTP status code gives you a coarse category and the `errors[]` payload in the response body gives you the specific message. That message often points directly at the fix. A typical error response looks like this: ```json theme={null} { "errors": [ { "message": "User does not have permission to update this resource." } ] } ``` GraphQL operations always return HTTP 200 even when the operation itself fails. The failure shows up in `errors[]`. Authentication and transport failures are the exception. The auth layer can return a 4xx or 5xx status code before GraphQL runs. ## HTTP status reference | Status | Meaning | When you'll see it | | - | - | - | | `200` | Success or GraphQL error | Always for `/graphql`. Check `errors[]` | | `400` | Malformed request | Invalid JSON body, a request body with no `query` key, missing required field on the wire | | `401` | Unauthenticated | Missing, expired, or invalid token. See [the 401 table](#401-unauthorized) | | `403` | Authenticated but not allowed | Permission, scope, or org-isolation failure. See [403 Forbidden](#403-forbidden) | | `404` | Resource not found | Wrong ID, soft-deleted entity, or not visible to your org | | `409` | Concurrency conflict | The `_etag` mismatch. Your update raced another writer. See [409 Concurrency conflict](#409-concurrency-conflict) | | `422` | Validation error | Field value violates a domain rule, such as quantity ≤ 0 | | `429` | Rate-limited | Back off and retry. See [429 Rate limit](#429-rate-limit) | | `5xx` | Server error | ION-side failure. Safe to retry with exponential backoff | One exception to the `400` row: a request whose body is entirely empty returns `200` with the error in `errors[]`, like any other GraphQL error. ## 401 Unauthorized ION rejects the request at the authentication layer. Here are the common messages and their fixes: | Message | Cause | Fix | | - | - | - | | `Please provide proper credentials` | No `Authorization` header on the request, or a header carrying a scheme with no token, such as a bare `Authorization: Bearer` | Add `Authorization: Bearer `, with the token after the scheme. | | `Unable to parse authentication token` | Malformed token, such as one that is truncated or in the wrong format | Verify the full token is being sent. A common cause is an env var that lost a trailing character. | | `Unable to find appropriate RSA key` | The token was signed by a key ION doesn't recognize | The token came from the wrong auth provider. Check that you're hitting the right `client_id` and audience. | | `Token is expired` | The access token's `exp` claim has passed | Refresh the token for OAuth, or re-issue it for an API key. | | `Unable to validate authentication token` | Generic verification failure | Re-issue the token. If it persists, check that the token audience and issuer match your environment. | | `Token organization does not match user's organization` | The token was issued for one org, but the user belongs to another | Re-authenticate the user against their actual organization. | | `User is deactivated` | The user has been deactivated in ION | Reactivate the user or use a different account. | | `Sorry, this organization is blocked from accessing ION` | The org is in a blocked state | Contact your CSM. | | `Login domain '' is not valid for this organization` | The user's email domain isn't allowed on the org | Add the domain to org settings or use an allowed email. | ## 403 Forbidden The request authenticated successfully, but the principal isn't authorized for the operation. The distinct causes each have a different fix. | Cause | What happened | How to fix | | - | - | - | | **Missing role permission** | The user or service account's role doesn't include the action being performed. For example, the role lacks the "create purchase order" permission. | An admin grants the role the missing permission, or assigns the user a role that has it. | | **Resource not visible to org** | The entity ID exists in another tenant's data. ION treats it as nonexistent for this caller. | Verify the ID belongs to your org. Cross-org references are never allowed. | | **Read-only organization** | The org is in read-only mode, such as a billing freeze or compliance hold, and any mutation is rejected. | Contact your CSM to release the read-only flag. | | **Read-only schema** | A specific schema, your tenant, is flagged read-only on the ION side. | Contact support. | | **Deactivated user** | The user account is deactivated. Auth still passes if the token is valid, but every operation returns a 403. | Reactivate the user in admin settings. | | **Approval gate not satisfied** | The operation requires an approval that hasn't been granted. For example, publishing a procedure that requires QE sign-off. | Complete the approval flow first. | | **OAuth scope insufficient** | The token was issued with limited scopes that don't cover the requested operation. | Re-authorize the OAuth app with broader scopes. | | **Feature flag disabled** | The operation is gated behind a feature flag not enabled for your org. | Contact your CSM to enable the feature for your tier. | | **Cross-org token** | A token issued for org A is trying to access org B's data. | Re-authenticate against the correct org. | | **Access blocked** | A guardrail blocks the caller outright. The error carries an `extensions.code` of `BLOCKED` and the message `Access blocked. Contact support if you believe this is in error.` | Retrying won't help. The block lifts only when it's changed on the ION side, so contact support. | > [!TIP] > > If a 403 says "permission", check the user's role. If it says "not found" or > refers to an ID, check the entity's tenant. If it says "read-only", check the > org's billing and compliance state. ### Sample 403 payload ```json theme={null} { "errors": [ { "message": "User does not have permission to perform UPDATE on Purchase Order." } ] } ``` The action verb (`UPDATE`) and the resource type (`Purchase Order`) are the two pieces an admin needs to find the missing role permission. ## 404 Not Found ION returns a 404, and a GraphQL `null` for the field, when the entity doesn't exist or doesn't belong to your tenant. The two cases are intentionally indistinguishable to prevent enumeration. A 404 doesn't leak that an ID exists in another org. Common causes: * An ID typo. * The entity was soft-deleted. * A cross-tenant ID. See 403 above. Sometimes this surfaces as a 404 instead, depending on the resolver. If the entity should exist, query a filtered list such as `parts(filters: { id: { in: [42] } }) { edges { node { id } } }` instead of `part(id: "42")`. The filtered query returns an empty `edges` array. That confirms a tenant or scope issue. ## 409 Concurrency conflict ION uses optimistic concurrency control via the `_etag` field. Every mutable entity returns an `_etag` on read. Mutations require you to pass back the `_etag` you received. If another writer modified the entity in the meantime, the etag won't match and ION returns a 409. ```json theme={null} { "errors": [{ "message": "Concurrent modification detected — etag mismatch." }] } ``` The fix is always the same: 1. Re-read the entity to get the latest `_etag` and the latest field values. 2. Re-apply your changes on top of the new state. 3. Retry the mutation with the new `_etag`. This is intentional. Re-reading surfaces the other writer's changes before you overwrite them. Always re-read and re-apply, even when you intend to discard the other writer's changes. ## 422 Validation error The request was structurally valid and authorized, but a field value violated a domain rule: * A quantity is zero or negative. * A required field is missing. * A date is out of range. * A string exceeds the maximum length. * An enum value is not allowed. The error message names the field and the constraint: ```json theme={null} { "errors": [{ "message": "PartInventory quantity must be greater than 0." }] } ``` These errors are deterministic. Fix the input and retry. ## 429 Rate limit ION applies fair-use rate limiting on the `/graphql` endpoint. Production traffic patterns rarely hit it. If you do, the response is HTTP 429 with an `extensions.code` of `RATE_LIMITED`, a `retryAfter` extension in seconds, and a matching `Retry-After` header: ```json theme={null} { "errors": [ { "message": "Rate limit exceeded — retry after 30s.", "extensions": { "code": "RATE_LIMITED", "retryAfter": 30 } } ] } ``` Address it in this order: 1. Honor `Retry-After`, then fall back to exponential backoff. Start at 1 second, double up to about 30 seconds, and add jitter. 2. Batch related queries. One query selecting many fragments beats several queries that each select one fragment. 3. Cache locally. For data that doesn't change often, such as parts and procedures, don't re-fetch every time. ### Guardrail error codes Three `extensions.code` values distinguish a guardrail rejection, and each maps to a different HTTP status and a different client response: | Code | What it means | What to do | | - | - | - | | `RATE_LIMITED` | The caller ran out of request budget for now. Returned as HTTP 429 with `retryAfter` and a `Retry-After` header. | Wait out `retryAfter`, then retry. | | `BLOCKED` | The caller is blocked outright rather than throttled. Returned as HTTP 403, with no `retryAfter` and no `Retry-After` header, because retrying can't succeed. | Stop retrying and contact support. | | `QUERY_COMPLEXITY_EXCEEDED` | The query itself exceeds a structural cap, such as nesting depth. The error names the `rule`, the `value` your query used, and the `limit`. | Change the query rather than retrying it: reduce nesting, or request a smaller page. | Key your retry policy off the code rather than the HTTP status alone, so a `BLOCKED` response isn't retried as if it were throttling. ## 5xx Server errors A 5xx response indicates a failure on ION's side. These responses are safe to retry with exponential backoff. ```http theme={null} HTTP/1.1 502 Bad Gateway ``` Standard recovery pattern: 1. Retry with exponential backoff. Use 1, 2, 4, and 8 seconds. 2. After three consecutive failures across about 30 seconds, surface the error to the user or on-call. 3. Check ION's status page if available, or contact support if the error persists. ## GraphQL errors\[] shape Inside the GraphQL response body, an HTTP 200, the `errors` array is the source of truth: ```json theme={null} { "data": null, "errors": [ { "message": "User does not have permission to perform UPDATE on Purchase Order.", "path": ["updatePurchaseOrder"], "locations": [{ "line": 2, "column": 3 }] } ] } ``` | Field | Meaning | | - | - | | `message` | Human-readable error. | | `path` | Which field in your query failed. | | `locations` | Position in the query string for IDE and playground integrations. | A partial `data` payload with a non-empty `errors[]` means the returned fields are valid and one or more other fields failed. ## Troubleshooting flow 1. Check the HTTP status. 2. If it's a 200, parse `errors[]` from the response body. 3. Match the message against the tables on this page. 4. If the message is unfamiliar, its wording usually points at the offending field, permission, or resource. Search for it in [Authentication](/api/authentication) and the tables on this page. 5. If you're still stuck, reproduce the call in the [API Playground](/api/playground), which surfaces errors more readably. Paste the request and error into a support ticket. > [!NOTE] > > Most 403s are fixed by granting the user's role the missing permission. Check permissions before you change code. For a 409, show the conflict to a human so > they can re-merge. # Example requests Source: https://docs.firstresonance.io/api/examples The most common queries and mutations you can run on the ION API Run these queries and mutations in the [API Playground](/api/playground). To send one from your own client, such as an HTTP action in an automation tool, put the operation in the JSON request body's `query` field as a string, and its variables in the `variables` field: ```json theme={null} { "query": "mutation CancelRun($input: CancelRunInput!) { cancelRun(input: $input) { run { id status } } }", "variables": { "input": { "id": 1234, "etag": "etag-from-your-query" } } } ``` > [tab] Queries > > > [accordion] Search parts > > > > Find parts by part number or description substring: > > > > ```graphql theme={null} > > query SearchParts($q: String!, $first: Int) { > > parts(filters: { partNumber: { ilike: $q } }, first: $first) { > > edges { > > node { > > id > > partNumber > > description > > revision > > partType > > status > > partSubtypes { id name } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "q": "%BRKT%", "first": 25 } > > ``` > > > [accordion] Get a procedure with all steps > > > > Fetch a procedure template plus every step and its fields: > > > > ```graphql theme={null} > > query GetProcedure($id: Int!) { > > procedure(id: $id) { > > id > > title > > steps { > > id > > title > > fields { id } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "id": 12 } > > ``` > > > [accordion] Get a run step field's values across runs > > > > Find every recorded value of one field, on run steps with a given title, across runs that build a given part number: > > > > ```graphql theme={null} > > query FieldValuesAcrossRuns($partNumber: String!, $stepTitle: String!, $fieldName: String!, $first: Int) { > > runStepFields( > > filters: { > > name: { eq: $fieldName } > > step: { > > title: { eq: $stepTitle } > > run: { part: { partNumber: { eq: $partNumber } } } > > } > > } > > first: $first > > ) { > > edges { > > node { > > id > > name > > value > > _updated > > updatedBy { id } > > step { > > id > > title > > run { > > id > > title > > partInventory { serialNumber } > > } > > } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "partNumber": "PN-1000", "stepTitle": "Torque check", "fieldName": "Torque", "first": 100 } > > ``` > > > [accordion] Get an aBOM's build requirements > > > > List the build requirements on a unit's as-built BOM: > > > > ```graphql theme={null} > > query AbomTree($id: Int!) { > > partInventory(id: $id) { > > id > > serialNumber > > part { partNumber } > > buildRequirements { > > id > > part { partNumber } > > quantity > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "id": 9876 } > > ``` > > > [accordion] Compare two aBOMs > > > > Pull the as-built BOMs of two units and diff them client-side: > > > > ```graphql theme={null} > > query CompareAboms($idA: Int!, $idB: Int!) { > > a: partInventory(id: $idA) { > > id > > serialNumber > > buildRequirements { id part { partNumber } quantity } > > } > > b: partInventory(id: $idB) { > > id > > serialNumber > > buildRequirements { id part { partNumber } quantity } > > } > > } > > ``` > > > > ```json theme={null} > > { "idA": 9876, "idB": 9877 } > > ``` > > > [accordion] List open runs > > > > Get the runs that are to do or in progress. Each run's `_etag` is the value an update mutation on that run needs: > > > > ```graphql theme={null} > > query OpenRuns { > > runs(filters: { status: { in: [TODO, IN_PROGRESS] } }, first: 100) { > > edges { > > node { > > id > > _etag > > title > > status > > procedure { id title } > > partInventory { id serialNumber part { partNumber } } > > } > > } > > } > > } > > ``` > > > [accordion] Run history for a part > > > > Every run a specific part inventory has gone through, newest first: > > > > ```graphql theme={null} > > query RunHistory($partInventoryId: Int!) { > > runs( > > filters: { partInventoryId: { eq: $partInventoryId } } > > sort: [_CREATED_DESC] > > first: 50 > > ) { > > edges { > > node { > > id > > title > > status > > _created > > procedure { id title } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "partInventoryId": 9876 } > > ``` > > > [accordion] Inventory for a part by location > > > > List inventory units of a given part, with each unit's location: > > > > ```graphql theme={null} > > query InventoryByLocation($partId: Int!) { > > partInventories(filters: { partId: { eq: $partId } }, first: 250) { > > edges { > > node { > > id > > serialNumber > > lotNumber > > quantity > > status > > location { id name type } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "partId": 12 } > > ``` > > > [accordion] Serialized units for a part > > > > Get every serialized instance of a part with its current state: > > > > ```graphql theme={null} > > query SerializedUnits($partId: Int!) { > > partInventories(filters: { partId: { eq: $partId } }, first: 250) { > > edges { > > node { > > id > > serialNumber > > status > > location { id name } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "partId": 12 } > > ``` > > > [accordion] List open issues by disposition > > > > All open issues, with each issue's disposition type for triage: > > > > ```graphql theme={null} > > query OpenIssuesByDisposition { > > issues( > > filters: { status: { in: [PENDING, IN_PROGRESS, IN_REVIEW] } } > > first: 250 > > ) { > > edges { > > node { > > id > > title > > status > > issueDispositionType { id title } > > assignedTo { id name } > > _created > > } > > } > > } > > } > > ``` > > > [accordion] List users with their IDs > > > > Match each user's numeric `id` to their name and email, such as to fill a setting that asks for user IDs or to read the user IDs in an export: > > > > ```graphql theme={null} > > query Users($after: String) { > > users(first: 100, after: $after) { > > edges { > > node { id name email } > > } > > pageInfo { endCursor hasNextPage } > > } > > } > > ``` > > > > While `hasNextPage` is `true`, run the query again with `after` set to the `endCursor` from the previous page. For more information, see [Paginate query results](/api/guides/pagination). > > > [accordion] Change history for a part > > > > List the recorded changes to one part, such as edits to its reorder points, with when each change happened, who made it, and the fields it changed: > > > > ```graphql theme={null} > > query PartHistory($partId: Int!) { > > loggedActions( > > filters: { rootTableName: { eq: PARTS }, rootModelId: { eq: $partId } } > > sort: [TIMESTAMP_DESC] > > first: 100 > > ) { > > edges { > > node { > > timestamp > > action > > tableName > > changedFields > > user { id name } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "partId": 12 } > > ``` > > > [accordion] Change history for a run > > > > List the recorded changes to one run, such as who changed its status and when: > > > > ```graphql theme={null} > > query RunHistory($runId: Int!) { > > loggedActions( > > filters: { rootTableName: { eq: RUNS }, rootModelId: { eq: $runId } } > > sort: [TIMESTAMP_DESC] > > first: 100 > > ) { > > edges { > > node { > > timestamp > > action > > tableName > > changedFields > > user { id name } > > } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { "runId": 42 } > > ``` > > > [accordion] Get current user and org > > > > Verify your token and find which org you're in: > > > > ```graphql theme={null} > > query Me { > > me { > > id > > name > > email > > organization { id domain } > > } > > } > > ``` > [tab] Mutations > > Most update, cancel, and delete mutations take the record's `id` and its current etag. Read `_etag` in the query that finds the records, then pass each record's value as `etag` in the mutation's input. For more information, see [Etag-based concurrency](/api/data-model#etag-based-concurrency). > > > [accordion] Create a part > > > > Create a new part in the library: > > > > ```graphql theme={null} > > mutation CreatePart($input: CreatePartInput!) { > > createPart(input: $input) { > > part { id partNumber description revision partType status } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "partNumber": "TEST-001", > > "description": "Integration test part", > > "revision": "A", > > "partType": "PART", > > "trackingType": "LOT" > > } > > } > > ``` > > > [accordion] Create a run from a procedure > > > > Start a new run by binding a procedure to a part inventory: > > > > ```graphql theme={null} > > mutation CreateRun($input: CreateRunInput!) { > > createRun(input: $input) { > > run { > > id > > title > > status > > procedure { id title } > > partInventory { id serialNumber } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "procedureId": 12, > > "partInventoryId": 9876, > > "title": "Build #2026-04-26 Unit 1" > > } > > } > > ``` > > > [accordion] Record a run step field value > > > > Set the value of one field on a run step. Pass the run step field's `id` and `_etag`: > > > > ```graphql theme={null} > > mutation RecordFieldValue($input: UpdateRunStepFieldValueInput!) { > > updateRunStepFieldValue(input: $input) { > > runStepField { id name value } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "id": 88, > > "etag": "etag-from-your-query", > > "value": "12.45" > > } > > } > > ``` > > > [accordion] Complete a run step > > > > Move a run step to complete. A run has no status of its own to set: it rolls up its status from its run steps. > > > > ```graphql theme={null} > > mutation CompleteStep($input: UpdateRunStepInput!) { > > updateRunStep(input: $input) { > > runStep { id status } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "id": 4567, > > "etag": "etag-from-your-query", > > "status": "COMPLETE" > > } > > } > > ``` > > > [accordion] Update several runs > > > > Change fields on several runs in one request. `updateRuns` takes a list of run inputs, each with its own `id` and `etag`, such as the runs a status-filtered query returned: > > > > ```graphql theme={null} > > mutation UpdateRuns($input: [UpdateRunInput]) { > > updateRuns(input: $input) { > > runs { id title assignedToId } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": [ > > { "id": 1234, "etag": "etag-for-1234", "assignedToId": 42 }, > > { "id": 1235, "etag": "etag-for-1235", "assignedToId": 42 } > > ] > > } > > ``` > > > [accordion] Cancel a run > > > > Cancel one run. `cancelRun` takes one run per request, so send it once for each run: > > > > ```graphql theme={null} > > mutation CancelRun($input: CancelRunInput!) { > > cancelRun(input: $input) { > > run { id status } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "id": 1234, > > "etag": "etag-from-your-query" > > } > > } > > ``` > > > [accordion] Create a purchase order > > > > Create a purchase order for a supplier. Then add each line with `createPurchaseOrderLine`: > > > > ```graphql theme={null} > > mutation CreatePO($input: CreatePurchaseOrderInput!) { > > createPurchaseOrder(input: $input) { > > purchaseOrder { > > id > > status > > supplier { id name } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "supplierId": 42 > > } > > } > > ``` > > > [accordion] Add a line to a purchase order > > > > Add a part and quantity to an existing purchase order: > > > > ```graphql theme={null} > > mutation AddPOLine($input: CreatePurchaseOrderLineInput!) { > > createPurchaseOrderLine(input: $input) { > > purchaseOrderLine { id quantity part { partNumber } } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "purchaseOrderId": 501, > > "partId": 12, > > "quantity": 100 > > } > > } > > ``` > > > [accordion] Create an issue linked to a run > > > > Open a quality issue tied to a specific run step: > > > > ```graphql theme={null} > > mutation CreateIssue($input: CreateIssueInput!) { > > createIssue(input: $input) { > > issue { > > id > > title > > status > > runStep { id } > > } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "title": "Surface scratches on RX-22 lot 4", > > "runStepId": 4567 > > } > > } > > ``` > > > [accordion] Close an issue with a resolution > > > > Move an issue to resolved once reviews are signed off: > > > > ```graphql theme={null} > > mutation ResolveIssue($input: UpdateIssueInput!) { > > updateIssue(input: $input) { > > issue { id status } > > } > > } > > ``` > > > > ```json theme={null} > > { > > "input": { > > "id": 7777, > > "etag": "etag-from-your-query", > > "status": "RESOLVED" > > } > > } > > ``` # Getting started Source: https://docs.firstresonance.io/api/getting-started Make your first authenticated GraphQL request to the ION API. ## Prerequisites * An ION organization. * An **API key** for machine-to-machine integrations, or **OAuth credentials** for user-facing applications. For how to obtain each, see [Authentication](/api/authentication). * A tool that can make HTTPS POST requests with JSON bodies, such as `curl`, `httpie`, or Postman. * Familiarity with GraphQL. > [!TIP] > > New to GraphQL? See the [official GraphQL > documentation](https://graphql.org/learn/). ## The endpoint Your API endpoint depends on the region your organization runs in. Send every request, with `POST`, to the API endpoint for your environment. For each production and sandbox environment's endpoint, see [ION environments](/getting-started/ion-basics#ion-environments). > [!NOTE] > > The examples in these guides use the US endpoint, `api.buildwithion.com`. Replace it with your region's endpoint. Authenticate each request with these headers: ``` Authorization: Bearer Content-Type: application/json ``` ## Get an access token If you have an **API key**, exchange it for a short-lived access token through your auth provider's client-credentials grant. For a reusable pattern, see the [Build an API client](/api/guides/python-quickstart). If you use **OAuth 2.0**, complete the authorization code flow in [Authenticate with OAuth 2.0](/api/authentication/oauth). After the user signs in, your callback receives an `access_token`. Both paths give you a JWT string. Treat it like a password. ## Make your first request A minimal "who am I?" query confirms the token works: > [tab] cURL > > ```bash theme={null} > curl -X POST https://api.buildwithion.com/graphql \ > -H "Authorization: Bearer $ION_TOKEN" \ > -H "Content-Type: application/json" \ > -d '{ > "query": "query { me { id name email organization { id domain } } }" > }' > ``` > [tab] Python > > Install `httpx` (`pip install httpx`), then run: > > ```python theme={null} > import os > import httpx > > resp = httpx.post( > "https://api.buildwithion.com/graphql", > headers={"Authorization": f"Bearer {os.environ['ION_TOKEN']}"}, > json={"query": "query { me { id name email organization { id domain } } }"}, > ) > resp.raise_for_status() > print(resp.json()["data"]["me"]) > ``` > > For a reusable client with retries and error handling, see the [Build an API client](/api/guides/python-quickstart). A successful response looks like this: ```json theme={null} { "data": { "me": { "id": 42, "name": "Ada Lovelace", "email": "ada@acme.com", "organization": { "id": 7, "domain": "acme.com" } } } } ``` If the response is an `errors` payload instead, see [Error codes](/api/error-codes) and its [401 table](/api/error-codes#401-unauthorized). ## Query data Once auth works, try a domain query that lists parts: > [tab] cURL > > ```bash theme={null} > curl -X POST https://api.buildwithion.com/graphql \ > -H "Authorization: Bearer $ION_TOKEN" \ > -H "Content-Type: application/json" \ > -d '{ > "query": "query { parts(filters: {}, first: 5) { edges { node { id partNumber description } } } }" > }' > ``` > [tab] Python > > ```python theme={null} > import os > import httpx > > resp = httpx.post( > "https://api.buildwithion.com/graphql", > headers={"Authorization": f"Bearer {os.environ['ION_TOKEN']}"}, > json={"query": "query { parts(filters: {}, first: 5) { edges { node { id partNumber description } } } }"}, > ) > resp.raise_for_status() > print(resp.json()["data"]["parts"]["edges"]) > ``` The response contains up to five parts from your org. If the response comes back empty, your org might not have parts yet. Query `me` again to confirm the token is valid. Then check the admin UI for data. ## Pick your next page Where to go next depends on what you're building: | If you're… | Go to | | - | - | | Building a reusable API client | [Build an API client](/api/guides/python-quickstart) | | Working through common queries and mutations | [Example requests](/api/examples) | | Building real-time event-driven integrations | [Set up webhooks](/api/guides/webhooks) | | Uploading files, such as procedure attachments and run artifacts | [Upload a file](/api/guides/file-upload) | | Mapping ION's data model into your system | [Data model](/api/data-model) | | Hitting a 403 or unfamiliar error | [Error codes](/api/error-codes) | | Testing without affecting production | [Sandbox](/api/sandbox) | | Taking an integration to production | [Build a production integration](/api/guides/build-a-production-integration) | # Build an aBOM Source: https://docs.firstresonance.io/api/guides/abom-as-built-bill-of-materials-api Build an as-built bill of materials (aBOM) with the ION API: install parts and manage build requirements. An as-built bill of materials (aBOM) tracks the build process of parts in a hierarchical tree. The aBOM records which part instances and lots are used to create parts, subsystems, and systems. The aBOM is a more detailed version of the mBOM, with relations to physical inventory rather than to parts. ## Set up part inventory To create an aBOM, you need inventory. For details on creating inventory, see [Manage part inventory and kitting](/api/guides/part-inventory-and-kitting). A part with inventory has a part number, and that part should have an mBOM. ION uses this mBOM to create the aBOM. When you first create the part inventory, it has only empty build requirements. Build requirements define the parameters for what parts you can install. ## Install parts You install a part by creating an aBOM installation. An aBOM installation links inventory to `buildRequirements`. To uninstall a part, delete its aBOM installation. Create the aBOM installation with this mutation: ```graphql theme={null} mutation CreateABomInstallation($input: CreateABomInstallationInput!) { createAbomInstallation(input: $input) { abomInstallation { buildRequirementId buildRequirementReferenceDesignatorId partInventoryId quantity } } } ``` Set the variables: ```json theme={null} { "input": { "buildRequirementId": 1, "partInventoryId": 3, "quantity": 1 } } ``` ## Edit build requirements You can add build requirements to an inventory that don't originate from the mBOM. Create the build requirement with this mutation: ```graphql theme={null} mutation CreateBuildRequirement($input: CreateBuildRequirementInput!) { createBuildRequirement(input: $input) { buildRequirement { fixedQuantityPerBuildRequirement id madeOnAssembly originMbomItemId partId partInventories { id } quantityPerParentPartInventory } } } ``` Set the variables: ```json theme={null} { "input": { "partId": 1, "partInventoryId": 484, "quantityPerParentPartInventory": 5, "madeOnAssembly": false } } ``` Update the build requirement with this mutation: ```graphql theme={null} mutation UpdateBuildRequirement($input: UpdateBuildRequirementInput!) { updateBuildRequirement(input: $input) { buildRequirement { fixedQuantityPerBuildRequirement id } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1031, "etag": "dca4e886ecce4a499d15411006a6d82a", "quantityPerParentPartInventory": 8 } } ``` This example changes the `quantityPerParentPartInventory` of the `buildRequirement`. You can also change the fixed quantity, made-on-assembly designation, substitutes, and reference designators. # Update run step fields Source: https://docs.firstresonance.io/api/guides/automatically-updating-fields-in-runs Query the fields on a run step and update a field value with the GraphQL API. To update a field on a run step, first query the run to find the field you want, then run a mutation to set its value. ## Get the fields Query the run to get the fields that exist on the run steps you want to update: ```graphql theme={null} { run(id: 419) { id steps { id fields { id name value type _etag } } } } ``` The response looks like this: ```json theme={null} { "data": { "run": { "id": 419, "steps": [ { "id": 1429, "fields": [ { "id": 1461, "name": "required_field", "value": null, "type": "STRING", "_etag": "066b1eb08dab44d6925d7bbd899e92cf" }, { "id": 1462, "name": "pass_fail", "value": null, "type": "BOOLEAN", "_etag": "066b1eb08dab44d6925d7bbd899e92cf" }, { "id": 1463, "name": "quality", "value": null, "type": "SIGNOFF", "_etag": "066b1eb08dab44d6925d7bbd899e92cf" } ] } ] } } } ``` In the response, find the field that you want to update. ## Update a field value From the example response above, suppose you want to update field `1462` because your test equipment can determine pass or fail. Use this mutation: ```graphql theme={null} mutation { updateRunStepFieldValue(input: { id: 1462, value: true, etag: "066b1eb08dab44d6925d7bbd899e92cf" }) { runStepField { id value } } } ``` The mutation includes the `etag` of the original field. The `etag` prevents accidental data overwrites by enforcing concurrency control. # Build a production integration Source: https://docs.firstresonance.io/api/guides/build-a-production-integration Take an integration from your first API call to production. This is the GraphQL API path to an integration. For other approaches, such as the Workflow Builder, see [Create an integration](/automate-with-ion/integrations/create-an-integration). Once your first calls work (see [Getting started](/api/getting-started)), follow this path to take an integration to production. ## Get access For your own org, ask an admin for access to your [sandbox](/api/sandbox). For an external org, that org grants you access to their environment. > [!WARNING] > > Gov Cloud is restricted to US persons only. If you're a non-US person building for a Gov Cloud organization, use your own ION sandbox and grant access to other domains instead. > [!NOTE] > > If your organization doesn't have a sandbox yet, reach out to First Resonance to request one. ## Set permissions An admin grants the permissions your integration needs. An API key holds the permissions its creating user had **at the moment it was generated**. Set those permissions first. See the [permissions reference](/administration/users-and-permissions#permissions-reference), [Manage API keys](/api/authentication/api-keys), and [Webhooks](/api/guides/webhooks). ## Connect Obtain an access token ([Authentication](/api/authentication)) and subscribe to the events you care about ([Webhooks](/api/guides/webhooks)). You can build the integration in a traditional environment such as Python or Node.js, or in a low-code iPaaS tool. ## Map the flow List the triggers, steps, and API calls your integration needs. Configure any new [custom attributes](/administration/custom-attributes) to represent data that doesn't have a home in ION yet. > [!NOTE] > > Every unique mutation in ION has an associated permission. Use the [API playground](/api/playground) to confirm which permissions a call requires before you build. ## Test and promote Validate your edge cases against the sandbox, then roll out to production. The production environment needs its own set of API keys and webhook receivers. # Edit time-tracking session data Source: https://docs.firstresonance.io/api/guides/edit-time-tracking-session-data Update the check-in and check-out times for a time-tracking session through the ION GraphQL API. You can edit a session through the API or from a run step. For the in-app workflow, see [Time tracking](/build-hardware/runs-and-execution/time-tracking). When you need to correct the check-in or check-out time for a session, update the session data through the ION API. ## Get the session ID and information Query for the sessions you want to edit. This query returns the last five sessions. To narrow the results, query by user or another parameter: ```graphql theme={null} { sessions (last: 5){ edges { node { id _etag runStep { runId position } checkIn checkOut createdBy { email } } } } } ``` ## Update the session data Once you have the `id` and `_etag`, use this mutation and input to modify the session data: ```graphql theme={null} mutation UpdateSession($input: UpdateSessionInput!) { updateSession(input: $input) { session { checkIn checkOut id } } } ``` Provide these query variables: ```json theme={null} { "input": { "id": "", "etag": "", "checkIn": "", "checkOut": "" } } ``` # Upload a file Source: https://docs.firstresonance.io/api/guides/file-upload Upload files to ION with a three-step flow: request a signed upload URL, send the file directly to ION's file storage, then register the attachment. ION stores file attachments such as procedure images, run artifacts, and inspection photos. You don't upload a file by posting it through the GraphQL endpoint. Instead, you use a three-step flow. Large files upload directly to storage rather than through ION. ## How the flow works 1. Send `requestFileUploadUrl` to ION. ION returns `uploadUrl`, `s3Key`, and `contentType`. 2. Send a PUT request with the file body and `Content-Type` header to `uploadUrl`. Storage returns a `200` response with an `ETag` header. 3. Send `createFileAttachment` to ION with `s3Key`, `s3Etag`, `entityId`, and `filename`. ION returns the `fileAttachment`. ## Prerequisites * An authenticated GraphQL client. See [Authentication](/api/authentication). * Permission to attach files to the entity you're targeting. * The **entity ID** of the object you're attaching to. See [Choose an entityId](#choose-an-entityid). ## Step 1: Request a signed upload URL ```graphql theme={null} query RequestUpload($filename: String!) { requestFileUploadUrl(filename: $filename) { uploadUrl s3Key contentType } } ``` **Variables:** ```json theme={null} { "filename": "inspection-photo-2026-04-26.jpg" } ``` **Response:** ```json theme={null} { "data": { "requestFileUploadUrl": { "uploadUrl": "https://ion-files.s3.amazonaws.com/...?X-Amz-Signature=...", "s3Key": "uploads/abc123/inspection-photo-2026-04-26.jpg", "contentType": "image/jpeg" } } } ``` The `uploadUrl` is valid for one hour. If you wait longer, the PUT request in step 2 fails. If that happens, request a new URL. The `contentType` in the response is the value you must send in the PUT request's `Content-Type` header. ION derives it from the filename extension, for example `application/pdf` for `.pdf` and `model/step` for `.step`. When the extension isn't recognized, `contentType` is `application/octet-stream`. See [Content type rules](#content-type-rules). ## Step 2: Upload the file Upload the file directly using the signed URL: ```bash theme={null} curl -X PUT "$UPLOAD_URL" \ -H "Content-Type: $CONTENT_TYPE" \ --data-binary "@./inspection-photo-2026-04-26.jpg" \ -i ``` The `-i` flag returns the response headers, including the `ETag` value: ```http theme={null} HTTP/1.1 200 OK ETag: "9c1185a5c5e9fc54612808977ee8f548" ``` That `ETag` value, with the surrounding quotes stripped, is your `s3Etag` for step 3. ION uses it to verify that the file you uploaded matches the registration you're about to create. > [!WARNING] > > Capturing the `ETag` is the most common file-upload bug. Confirm your HTTP > library exposes response headers and isn't using a wrapper that discards them. ## Step 3: Register the attachment ```graphql theme={null} mutation RegisterUpload($input: CreateFileAttachmentInput!) { createFileAttachment(input: $input) { fileAttachment { id filename downloadUrl entityId } } } ``` **Variables:** ```json theme={null} { "input": { "filename": "inspection-photo-2026-04-26.jpg", "s3Key": "uploads/abc123/inspection-photo-2026-04-26.jpg", "s3Etag": "9c1185a5c5e9fc54612808977ee8f548", "entityId": 9876, "validateUpload": true } } ``` **Response:** ```json theme={null} { "data": { "createFileAttachment": { "fileAttachment": { "id": 4242, "filename": "inspection-photo-2026-04-26.jpg", "downloadUrl": "https://ion-files.s3.amazonaws.com/...", "entityId": 9876 } } } } ``` After this returns successfully, the file is visible in the ION UI on the entity you attached it to. ### Input fields | Field | Type | Notes | | - | - | - | | `filename` | `String` | Display filename. It doesn't have to match the storage object's key. | | `s3Key` | `String` | The `s3Key` value from step 1, which is the storage object key. With `validateUpload`, it must be a key that ION returned to the same user. Any other key fails with `Invalid s3 key.` | | `s3Etag` | `String` | The `ETag` returned by the storage service in step 2's response, with quotes stripped. | | `entityId` | `ID` | The **entity ID** of the parent object. See [Choose an entityId](#choose-an-entityid). | | `validateUpload` | `Boolean` | When `true`, ION verifies that the uploaded object exists and matches the `ETag` before creating the record. Recommended. | > [!TIP] > > With `validateUpload` set to `true`, ION makes one extra HEAD request and gives you > immediate feedback when the registration doesn't match the uploaded bytes. ## Content type rules The signed upload URL is bound to one content type. Storage rejects the PUT request unless its `Content-Type` header matches exactly. * ION guesses the content type from the stored file name. Known extensions return their standard type, such as `application/pdf` or `model/step`. * When the extension isn't recognized, ION signs the URL for `application/octet-stream`. Send `application/octet-stream` in that case. Renaming the file to get a different type isn't required. * Use the value ION returns, not your own guess. In the flow above it is `contentType` from `requestFileUploadUrl`. In the [create-first flow](#alternative-create-the-attachment-first) it is `fileAttachment.contentType`. * Sending any other `Content-Type` returns `403 SignatureDoesNotMatch`. ## Alternative: create the attachment first Instead of requesting a URL first, you can create the attachment record and upload the bytes afterward. This flow skips `s3Etag` and `validateUpload`. ```graphql theme={null} mutation CreateAttachment($input: CreateFileAttachmentInput!) { createFileAttachment(input: $input) { fileAttachment { id filename contentType } uploadUrl } } ``` **Variables:** ```json theme={null} { "input": { "filename": "inspection-photo-2026-04-26.jpg", "entityId": 9876 } } ``` Send a PUT request with the file body to `uploadUrl`. Set the `Content-Type` header to `fileAttachment.contentType`. The same one-hour expiry and exact content type rules apply. ION creates the attachment record before the upload happens. If the upload never completes, the record exists without a file behind it. Use the three-step flow with `validateUpload` when you need ION to confirm the upload before it creates the record. The `createFileAttachment` mutation always returns `uploadUrl`, including in the three-step flow, where you can ignore it. ## Link an external file To attach a file that stays in another system, pass `integrationId`, `integrationFetchUrl`, and `filename` instead of uploading bytes: ```json theme={null} { "input": { "filename": "drawing.pdf", "integrationId": "my-integration", "integrationFetchUrl": "https://example.com/files/drawing.pdf", "entityId": 9876 } } ``` ION stores only the link. No bytes are uploaded, `uploadUrl` is an empty string, and `downloadUrl` is `null`. `integrationId` and `integrationFetchUrl` are the only fields that set up this mode, so don't send `s3Key` with them. ## File types, size limits, and previews * ION doesn't enforce a file type or file size limit on attachments. Files upload directly to storage, so limits set by your network or proxy can still apply. * Each flow uploads the file in a single PUT request. Amazon S3 limits a single PUT request to 5 GB, so files larger than 5 GB can't use these flows. * Whether ION shows a preview depends on the file type. This guide doesn't list the types that preview. ## Choose an entityId The `entityId` is not the same as the parent object's `id`. ION lets multiple object types share a relationship to file attachments, so you pass the parent's entity ID rather than its own `id`. To attach a file to a run step, the most common case, first fetch the run step's `entity.id`: ```graphql theme={null} query GetRunStepEntity($runStepId: ID!) { runStep(id: $runStepId) { id entity { id } } } ``` Use the returned `entity.id`, not `runStep.id`, as the `entityId` in step 3. The same pattern applies to other targets: | Attachment target | Fetch its `entity.id` via | | - | - | | Run step | `runStep(id) { entity { id } }` | | Run | `run(id) { entity { id } }` | | Procedure | `procedure(id) { entity { id } }` | | Procedure step | `step(id) { entity { id } }` | | Part | `part(id) { entity { id } }` | | Run step field | `runStepField(id) { entity { id } }` | ## End-to-end example in Python The example uses the US endpoint. Set `GQL_URL` to your region's [API endpoint](/getting-started/ion-basics#ion-environments): ```python theme={null} import httpx import os ION_TOKEN = os.environ["ION_TOKEN"] GQL_URL = "https://api.buildwithion.com/graphql" def gql(query, variables=None): r = httpx.post( GQL_URL, headers={"Authorization": f"Bearer {ION_TOKEN}"}, json={"query": query, "variables": variables or {}}, timeout=30.0, ) r.raise_for_status() payload = r.json() if "errors" in payload: raise RuntimeError(payload["errors"]) return payload["data"] def upload_to_run_step(run_step_id: int, file_path: str) -> int: filename = os.path.basename(file_path) # 1. Get a signed upload URL step_1 = gql( "query($f: String!) { requestFileUploadUrl(filename: $f) { uploadUrl s3Key contentType } }", {"f": filename}, )["requestFileUploadUrl"] # 2. PUT the file to the signed URL, capture the ETag from the response with open(file_path, "rb") as f: upload_response = httpx.put( step_1["uploadUrl"], content=f.read(), headers={"Content-Type": step_1["contentType"]}, timeout=120.0, ) upload_response.raise_for_status() s3_etag = upload_response.headers["ETag"].strip('"') # 3. Resolve the run step's entity.id entity_id = gql( "query($id: ID!) { runStep(id: $id) { entity { id } } }", {"id": run_step_id}, )["runStep"]["entity"]["id"] # 4. Register the attachment result = gql( """mutation($input: CreateFileAttachmentInput!) { createFileAttachment(input: $input) { fileAttachment { id filename } } }""", { "input": { "filename": filename, "s3Key": step_1["s3Key"], "s3Etag": s3_etag, "entityId": entity_id, "validateUpload": True, } }, ) return result["createFileAttachment"]["fileAttachment"]["id"] ``` For the full Python integration template, see [Build an API client](/api/guides/python-quickstart). ## Common errors | Symptom | Cause | Fix | | - | - | - | | `403 Forbidden` on the upload PUT | The upload URL expired. URLs are valid for one hour. | Re-request the URL and use it right away. | | `403 SignatureDoesNotMatch` on the upload PUT | The `Content-Type` header doesn't match what was signed. | Send exactly the `contentType` returned in step 1. | | `validateUpload` mutation fails | The `s3Etag` doesn't match what storage has. | Capture the `ETag` after a successful `200` response, not the request hash. | | `Invalid s3 key.` on `createFileAttachment` with `validateUpload` | The `s3Key` wasn't returned to the calling user by `requestFileUploadUrl`. | Request the key as the same user that registers the attachment. | | Attachment created but not visible in the UI | The wrong `entityId`, the parent's `id` instead of `entity.id`. | Re-fetch the parent's `entity { id }` and register again. | | `Permission denied` on `createFileAttachment` | The user or service account lacks attach permission for the target entity. | Check the role's permissions on the parent resource, such as run step update. | ## Verify the attachment After step 3, you can confirm the attachment in two ways: * In the ION UI, open the parent entity and check the attachments panel. * Via the API, query the attachment back by ID: ```graphql theme={null} query VerifyUpload($id: ID!) { fileAttachment(id: $id) { id filename downloadUrl entityId } } ``` The `downloadUrl` is a fresh signed download URL, time-bound. Don't cache it long-term. > [!TIP] > > Set a longer timeout for the upload PUT in step 2 than for your GraphQL > requests. For large files, the upload is the slowest part of the flow. # Manage mBOM versions and release approvals Source: https://docs.firstresonance.io/api/guides/mbom-versions-and-release Create mBOM versions, move them between statuses, and set up the approvals that gate release through the ION GraphQL API. A part's mBOM is versioned. A version's status decides whether you can edit it and which statuses it can move to, and approvals can gate its release. You edit the items of an editable version: a version in **Draft**, or one in **In Review** that no reviewer has approved or rejected. For which changes need a new version, see [Manage BOM versions](/build-hardware/bills-of-materials/versions). To manage the items in a version, see [Manage mBOM items](/api/guides/mboms). ## mBOM statuses | Status | API value | What you can do | | - | - | - | | **Draft** | `DRAFT` | Edit the items. A new version starts here. | | **In Review** | `IN_REVIEW` | Edit the items until a reviewer approves or rejects the version. After that, the items are read only until the version moves back to **Draft**. Reviewers approve the version while it's in this status. | | **Released** | `RELEASED` | Read only. | | **Archived** | `ARCHIVED` | Read only. | A version can move between statuses as follows: | From | Can move to | | - | - | | **Draft** | **In Review**, **Archived** | | **In Review** | **Draft**, **Released**, **Archived** | | **Released** | **Draft**, **In Review**, **Archived** | | **Archived** | **Draft**, **In Review** | A version can't go straight from **Draft** to **Released**. Move it to **In Review** first. `isLatestVersion` is true for the part's highest version number. `isLatestReleasedVersion` is true for the highest version number among the part's **Released** versions. ## Create an mBOM version Create a version with `createMbom`. The new version gets the next version number for the part and starts in **Draft**. ```graphql theme={null} mutation CreateMBom($input: CreateMBomInput!) { createMbom(input: $input) { mbom { id partId version status } } } ``` Set the variables: ```json theme={null} { "input": { "partId": 1 } } ``` By default, the new version is a copy of the part's latest version, including every item with its substitutes and reference designators. If the part has no mBOM yet, the new version is empty. Two options change what gets copied: * `copyMbom` defaults to `true`. Set it to `false` to create an empty version. * `mbomId` copies a specific version instead of the latest. The version must belong to the part in `partId`. Don't combine `mbomId` with `copyMbom: false`. The request fails with one of these messages when the options conflict: | Cause | Message | | - | - | | `mbomId` with `copyMbom` set to `false` | `mbomId cannot be used when copyMbom is false.` | | `mbomId` for a different part | `mbomId (X) to be copied does not match specified partId (Y).` | ## Move an mBOM between statuses Change a version's status with `updateMbom`. Pass the mBOM's `id`, its current `etag`, and the new `status`. The `id` is an `Int!`. The item mutations and `deleteMbom` take an `ID!` instead. ```graphql theme={null} mutation UpdateMBom($input: UpdateMBomInput!) { updateMbom(input: $input) { mbom { id status version } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1, "etag": "etag1", "status": "IN_REVIEW" } } ``` A move that the table in [mBOM statuses](#mbom-statuses) doesn't allow fails with `MBom with status DRAFT cannot transition to RELEASED.`, with the two statuses in place of `DRAFT` and `RELEASED`. Two rules apply to specific moves: * **Moving to Released.** If the organization has release approvals, the move fails with `Cannot set mBOM status to RELEASED until all approval requests have been approved.` until the approvals in [Release approvals](#release-approvals) are in place. Moving to **In Review** never needs approval. * **Moving a Released version back to Draft or In Review.** The move fails if aBOM build requirements or part kit items reference the version's items. The message names the kinds of record that block it, as in `mBOM cannot be deleted or moved from RELEASED status because BuildRequirements, PartKitItems reference mBOM items from this mBOM.` Moving a Released version to **Archived** isn't blocked this way. ## Delete a draft mBOM You can delete only a version in **Draft**. Deleting a version in any other status fails, and so does deleting a draft whose items are referenced by aBOM build requirements or part kit items. Delete the version with `deleteMbom`, passing the `id` and the current `etag`. ```graphql theme={null} mutation DeleteMBom($id: ID!, $etag: String!) { deleteMbom(id: $id, etag: $etag) { id } } ``` Set the variables: ```json theme={null} { "id": 1, "etag": "etag1" } ``` ## Release approvals Release approvals are optional. An organization turns them on by adding approval roles to the **Released** gate. Each approval role names an ION role and the number of approvers from that role that a release needs. A version can move to **Released** when both of these are true: * Every approval request on the version is approved. * For each approval role, the version has at least that role's `count` of approval requests. If the organization has no approval roles and a version has no approval requests, the version can move to **Released** with no approval. ### Set up approval roles You manage approval roles through the API only. ION has no page for them. The only gate is `RELEASED`. Create a role with `createMbomApprovalRole`: ```graphql theme={null} mutation CreateMBomApprovalRole($input: CreateMBomApprovalRoleInput!) { createMbomApprovalRole(input: $input) { approvalRole { roleId gateType count } } } ``` Set the variables: ```json theme={null} { "input": { "roleId": 3, "gateType": "RELEASED", "count": 2 } } ``` `count` must be 1 or more. A role that already exists for the gate is changed with `updateMbomApprovalRole` and removed with `deleteMbomApprovalRole`. Both take the role's `roleId`, the `gateType`, and the current `etag`. List the roles with the `mbomApprovalRoles` query. ### Request and record approvals An approval request is a separate record. Create one request for each person who should approve: ```graphql theme={null} mutation CreateMBomApprovalRequest($input: CreateMBomApprovalRequestInput!) { createMbomApprovalRequest(input: $input) { approvalRequest { id status roleId assignedToId } } } ``` Set the variables: ```json theme={null} { "input": { "mbomId": 1, "gateType": "RELEASED", "roleId": 3, "assignedToId": 12 } } ``` These rules apply to a request: * The version must be in **Draft** or **In Review**. Otherwise the request fails with `Cannot create approval request for released gate unless the status is at or before in_review.` * The person in `assignedToId` must hold the role in `roleId`. Otherwise the request fails with `The assignee does not have the role` and the role's name. * A person can have only one request per version and gate. The assignee records their decision with `createMbomApproval`. The approval is recorded for the user that makes the call. ```graphql theme={null} mutation CreateMBomApproval($input: CreateMBomApprovalInput!) { createMbomApproval(input: $input) { approval { id status mbomId reviewer { id } } } } ``` Set the variables: ```json theme={null} { "input": { "mbomId": 1, "gateType": "RELEASED", "status": "APPROVED", "comment": "Approved", "content": [{ "children": [{ "text": "Approved" }] }] } } ``` `content` is required. `status` is `APPROVED`, `REJECTED`, or `PENDING`. An approval with the `PENDING` status is a comment and doesn't need a request. For `APPROVED` and `REJECTED`, these rules apply: * The version must be in **In Review**. Otherwise the call fails with `Cannot do approval if MBoms is not in in_review status.` * You must have an approval request on the version. Otherwise the call fails with `You have no approval requests that match the approval requests.` * You can approve a gate only once. A second approval fails with `You have already approved an approval request for this approval gate.` Once every request is approved and each role has its `count`, move the version to **Released** with `updateMbom`. An organization setting decides whether a procedure uses a pinned mBOM version. For more information, see [Enable mBOM version selection](/administration/production-settings/enable-mbom-version-selection). # Manage mBOM items Source: https://docs.firstresonance.io/api/guides/mboms Query and manage mBOM items and substitutes through the ION GraphQL API. An mBOM item represents the bill of materials required to construct a part. A part has an mBOM made up of many mBOM items, which dictate the subparts used in the part's construction. You can think of parts as a tree structure, where the nodes are part objects and the edges are mBOM items. The root of the tree is a part representing a completed assembly. Its mBOM is the parts used in its construction. Each of those parts can have its own mBOM. ## mBOM items | mBOM item | Description | | - | - | | id | Unique identifier of the mBOM item object. | | parent | The [part](/api/guides/parts-and-part-revisioning) object whose construction this mBOM item describes. | | part | The [part](/api/guides/parts-and-part-revisioning) object used in the construction of the parent. | | quantity | The amount of a specific part needed in construction. | | substitutes | List of valid substitutes that can be used in place of the specified part. | ## mBOM substitutes An mBOM substitute is a valid alternative that can be used in place of the defined part. Each mBOM item can have many mBOM substitutes, which are subpart replacements for that specific subpart. | mBOM substitute | Description | | - | - | | id | Unique identifier of the mBOM substitute object. | | part | The [part](/api/guides/parts-and-part-revisioning) object that can be substituted for the part in the mBOM item. | | mbomItem | The mBOM item for which this object is a valid substitute. | ## Query an mBOM item It is often more effective to query the mBOM relation through a part object. List mBOM items with a filter: ```graphql theme={null} query MBOMItems($filters: MBomItemsInputFilters) { mbomItems(filters: $filters) { edges { node { id partId parentId quantity } } } } ``` Set the filter variables: ```json theme={null} { "filters": { "parentId": { "eq": 1 } } } ``` Get a single mBOM item by ID: ```graphql theme={null} query GetMBOMItem { mbomItem(id: 1) { id partId parentId quantity } } ``` ## Explode a multi-level mBOM `mbomExplosion` returns every descendant line of a root assembly's mBOM in one request, so you don't have to walk the tree one request per node. ```graphql theme={null} query MBomExplosion($input: MBomExplosionInput!) { mbomExplosion(input: $input) { edges { node { level parentPartId quantity totalQuantity mbomItem { id partId parentId } } } } } ``` Set the variables: ```json theme={null} { "input": { "partId": 1 } } ``` Each node describes one line of the exploded tree: | Field | Description | | - | - | | `level` | Depth in the tree. Lines on the root mBOM are level 1. | | `parentPartId` | The part whose assembly this line sits under. | | `quantity` | The line's own quantity, per one unit of its parent assembly. | | `totalQuantity` | The quantity rolled up through the tree: the parent's total multiplied by `quantity`. | | `mbomItem` | The underlying mBOM item, so you can select the part, substitutes, and designators. | Lines come back depth-first, so you can rebuild the tree, or write a CSV, straight from the order they arrive in. `partId` is required. `mbomId` is optional and sets the version used for the **root** level only: pass it to explode a specific version, or omit it to use the part's released mBOM, falling back to its latest when there is no released version. Nested levels always resolve released-else-latest. Passing an `mbomId` that belongs to a different part returns a validation error. ### What the results leave out Three cases drop lines from the response without returning an error, so check for them before treating a result as a complete tree: * **Repeated parts.** If a part already appears higher in the same branch, the line for it is left out of the results entirely, rather than returned without its children. A cyclic mBOM terminates instead of looping. * **Export-controlled parts.** When you aren't allowed to see an export-controlled part, its line is omitted along with everything below it. If the **root** assembly itself is export-controlled, the query returns no lines at all, which reads the same as an assembly that has no mBOM. * **Very deep trees.** Explosion stops after 100 levels. Anything deeper is dropped silently. ## Query an mBOM substitute List mBOM substitutes with a filter: ```graphql theme={null} query MBOMSubstitutes($filters: MBomSubstituteInputFilters) { mbomSubstitutes(filters: $filters) { edges { node { id partId parentId mbomItemId } } } } ``` Set the filter variables: ```json theme={null} { "filters": { "mbomItemId": { "eq": 1 } } } ``` Get a single mBOM substitute by ID: ```graphql theme={null} query MBOMSubstitute { mbomSubstitute(id: 1) { id partId parentId mbomItemId } } ``` ## Create an mBOM item An mBOM item defines which part, and how many of it, a new part needs. `parent` is the part being built, and `part` is the part required in the build. The quantity must be 0 or more. An item that's made on assembly can't have a quantity of 0, and a serial-tracked part needs a whole-number quantity. An mBOM can have one item for each part, and you can add items only to an editable version. For more information, see [Manage mBOM versions and release approvals](/api/guides/mbom-versions-and-release). Create the mBOM item with this mutation: ```graphql theme={null} mutation($input: CreateMBomItemInput!){ createMbomItem(input: $input){ mbomItem { id parentId partId quantity } } } ``` Set the variables: ```json theme={null} { "input": { "parentId": 2, "partId": 1, "quantity": 3 } } ``` ## Update an mBOM item You can update the quantity of an mBOM item and its associated part. Returns the updated mBOM item. Update the mBOM item with this mutation: ```graphql theme={null} mutation UpdateMBomItem($input: UpdateMBomItemInput!) { updateMbomItem(input: $input) { mbomItem { id parentId partId quantity } } } ``` Set the variables: ```json theme={null} { "input": { "etag": "etag1", "id": 1, "partId": 3, "quantity": 5 } } ``` ## Create mBOM substitutes Create a valid substitution for a specific part within an mBOM. Any parts listed with mBOM substitutes do not raise a validation error if they are attached to an aBOM instead of the part specified in the original mBOM item. Create the mBOM substitutes with this mutation: ```graphql theme={null} mutation CreateMbomSubstitutes($input: [CreateMBomSubstituteInput]!){ createMbomSubstitutes(input: $input){ mbomSubstitutes { id parentId partId mbomItemId } } } ``` Set the variables: ```json theme={null} { "input": [ { "partId": 3, "parentId": 2, "mbomItemId": 1 }, { "partId": 4, "parentId": 2, "mbomItemId": 1 } ] } ``` ## Delete an mBOM item You can delete an mBOM item from an editable version. If an aBOM build requirement uses the item, the item stops appearing on the mBOM but isn't removed. Returns the ID of the deleted mBOM item. Delete the mBOM item with this mutation: ```graphql theme={null} mutation DeleteMBomItem($id: ID!, $etag: String!){ deleteMbomItem(id: $id, etag: $etag){ id } } ``` Set the variables: ```json theme={null} { "id": 1, "etag": "etag1" } ``` ## Delete an mBOM substitute Delete the mBOM substitute with this mutation: ```graphql theme={null} mutation DeleteMBomSubstitute($id: ID!, $etag: String!){ deleteMbomSubstitute(id: $id, etag: $etag){ id } } ``` Set the variables: ```json theme={null} { "id": 1, "etag": "etag1" } ``` # Send a custom notification Source: https://docs.firstresonance.io/api/guides/notifications Send custom notifications to ION users with the dispatchNotification GraphQL mutation. ION has a notification system built into the application's workflows, with both native notifications and notifications you can send through the ION API. For example, when you're assigned to an approved issue disposition, you receive a notification. Toast notifications appear in the interface. ION checks for toast notifications every 30 seconds, so a toast can take up to 30 seconds to appear. ## Send a custom notification Use the `dispatchNotification` mutation to send custom notifications: ```graphql theme={null} mutation notification($input:DispatchNotificationInput!){ dispatchNotification(input: $input){ response{ messageId } } } ``` Use these query variables: ```json theme={null} { "input": { "userId": 3660, "notificationType": "WARNING", "description": "Purchase order versioned and PDF file generated. Please refresh.", "title": "PO Versioned & PDF Generated", "linkText": "This is the link", "path": "https:///" } } ``` The query variables are: * `userId`: The ID of the user you want to send the notification to. * `notificationType`: The type of notification to dispatch. * `description`: A brief description of the notification's content. * `title`: The title of the notification, displayed in the toast notification. * `linkText`: The text displayed as the link in the notification page, directing users to further details or actions. * `path`: The URL path users go to when they click either the toast notification or the notification in the application. ## Notification types ION supports the following notification types: * `EXTERNAL`: Notifications originating from external systems, typically used for general updates. * `SIGNOFF`: Notifications requiring user attention or signoff. * `WARNING`: A critical event the user should be aware of. # Paginate query results Source: https://docs.firstresonance.io/api/guides/pagination Use cursor-based pagination to fetch large GraphQL result sets in batches and avoid timeouts. For any query that returns a list of results, you should use pagination. Without pagination, a large query is more likely to time out and return a 502 error. A 502 occurs when an API call doesn't receive a response within 30 seconds. The ION GraphQL API uses a cursor pagination pattern. ## Fetch the first page This example queries the first five parts with the `first` parameter and fetches the `endCursor` in the `pageInfo` object: ```graphql theme={null} { parts(first: 5) { edges { node { id } } pageInfo { endCursor # use this to fetch the next page hasNextPage # are there more parts after this page? totalCount #total number of parts count #number of parts returned by this query } } } ``` ```json theme={null} { "data": { "parts": { "edges": [ { "node": { "id": 20 } }, { "node": { "id": 22 } }, { "node": { "id": 24 } }, { "node": { "id": 26 } }, { "node": { "id": 28 } } ], "pageInfo": { "endCursor": "YXJyYXljb25uZWN0aW9uOjE5", "hasNextPage": true, "totalCount": 1259, "count": 5 } } } } ``` In addition to `first`, ION queries have the pagination parameters `last`, `before`, and `after`. ## Fetch the next page To fetch the next page, pass the `endCursor` from the previous query to the `after` parameter: ```graphql theme={null} { parts(first: 5, after: "YXJyYXljb25uZWN0aW9uOjE5") { edges { node { id } } pageInfo { endCursor # use this to fetch the next page hasNextPage # are there more parts after this page? totalCount #total number of parts count #number of parts returned by this query } } } ``` To query every part in ION, repeat this pattern to fetch parts in batches of five. Use `hasNextPage` to determine whether more results remain after each query. # Manage part inventory and kitting Source: https://docs.firstresonance.io/api/guides/part-inventory-and-kitting Create part inventory through the ION API, issue parts to kits to allocate inventory to runs, and move parts back to inventory. ## Inventory ION tracks parts by serial number or lot number. You can also leave a part untracked and record only its quantity. Part inventory holds information about a part and sets it up so you can track it in runs and aBOM construction. | Part inventory | Description | | - | - | | id | Unique identifier for a part inventory object. | | serialNumber | Required if the part is serial tracked. Must be unique per part, so another inventory object with the same part relation cannot have a matching serial number. Can optionally be autogenerated. | | lotNumber | Required if the part is lot tracked. Can optionally be autogenerated. | | location | Location where the inventory object is stored. | | part | [Part](/api/guides/parts-and-part-revisioning) that this inventory object is an instance of. | | unitOfMeasure | How the quantity of this inventory object is measured. | | quantity | Amount of inventory present. | | runs | [Runs](/api/guides/runs) related to this inventory object. | | installed | `true` if all quantity is attached to aBOM items, otherwise `false`. | | kitted | `true` if all quantity is kitted to runs, otherwise `false`. | ### Inventory tracking types | Tracking type | | | - | - | | serial | Any inventory with a serial number has the serial tracking type. It can also have a lot number in addition. Serialized inventory objects can only have a quantity of 0 or 1. | | lot | Any inventory object with a lot number and no serial number is lot tracked. Lot-tracked items must have a quantity greater than or equal to 0. | | untracked | If a part inventory has neither a serial nor a lot number, it is an untracked item. There are no quantity restrictions on an untracked part. | ### Query part inventories List part inventory with a filter: ```graphql theme={null} query PartInventories($filters: PartInventoriesInputFilters, $sort: [PartInventorySortEnum]) { partInventories(sort: $sort, filters: $filters, first: 50) { edges { node { id cost quantity usageType part { partNumber } location { id } } } } } ``` Set the filter variables: ```json theme={null} { "filters": { "locationId": { "eq": 1 } } } ``` Get a single part inventory record by ID: ```graphql theme={null} query PartInventory { partInventory(id: 1) { id cost quantity usageType part { partNumber } location { id } } } ``` ### Create part inventories When you specify no quantity, the inventory object has a quantity of 0. You can also autogenerate the serial number or lot number. Create the inventory with this mutation: ```graphql theme={null} mutation CreatePartInventory($input: CreatePartInventoryInput!) { createPartInventory(input: $input) { partInventory { id quantity cost usageType createdById trackingType locationId supplierId _etag } } } ``` A serialized part can also belong to a lot, so the input can include a lot number. A serial-tracked part cannot have a quantity greater than 1. Set the variables for a serialized part: ```json theme={null} { "input": { "serialNumber": "sn-1", "lotNumber": "123", "quantity": 1, "partId": 1, "supplierId": 1, "locationId": 5 } } ``` Set the variables for a lot-tracked part: ```json theme={null} { "input": { "lotNumber": "lot-12", "partId": 2, "supplierId": 1, "locationId": 5 } } ``` Autogenerate a serial or lot number with these variables: ```json theme={null} { "input": { "autogenerateSerialNumber": true, "autogenerateLotNumber": true, "lotNumber": "123", "quantity": 1, "partId": 1, "supplierId": 1, "locationId": 5 } } ``` ### Update inventory items You can change almost all the fields on an inventory object except its relation to the part it is an instance of. All the quantity and tracking-type validations enforced on creation are also enforced on update. Update the inventory with this mutation: ```graphql theme={null} mutation UpdatePartInventory($input: UpdatePartInventoryInput!) { updatePartInventory(input: $input) { partInventory { id quantity cost locationId serialNumber lotNumber } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1, "etag": "etag1", "lotNumber": "ion-21", "cost": 11.21, "locationId": 1 } } ``` ### Delete part inventories Delete the inventory with this mutation: ```graphql theme={null} mutation DeletePartInventory($id: ID!, $etag: String!) { deletePartInventory(id: $id, etag: $etag) { id } } ``` Set the variables: ```json theme={null} { "id": 1, "etag": "etag1" } ``` ## Issue parts to runs ### Part kits Part kits let you allocate specific parts and quantities for a run. To create a part kit, you must already have a run. See the [Runs](/api/guides/runs) example for how to create one. To remove parts from inventory and attach them to the run that consumes them, use a part kit object. | Part kits | Description | | - | - | | id | Unique identifier for a part kit object. | | run | [Run](/api/guides/runs) that inventory objects are kitted to. | | partInventories | Inventory objects with an additional field, `issuedQuantity`, which identifies the quantity of the inventory allocated to the run. | Create a kit with this mutation: ```graphql theme={null} mutation CreatePartKit($input: CreatePartKitInput!) { createPartKit(input: $input) { partKit { id run { id title } } } } ``` Set the variables: ```json theme={null} { "input": { "runId": 1 } } ``` ### Issue inventory to kits To move parts from inventory into the part kit, use the `issueItemToKit` mutation. Whether a part is serial-tracked, lot-tracked, or untracked, you reference its `partInventoryId` and, when the item is not serial-tracked, the `quantity` you want to issue to that kit: Issue an item to the kit with this mutation: ```graphql theme={null} mutation IssueItemToKit($input: InventoryToKitInput!) { issueItemToKit(input: $input) { partInventory { id serialNumber partKits { id } } } } ``` Set the variables: ```json theme={null} { "input": { "partInventoryId": 1, "etag": "etag", "partKitItemId": 1 } } ``` Issuing serials, lots, or untracked parts uses the same `issueItemToKit` mutation. When you issue parts to a kit, the kit shows the quantity of that required part fulfilled as `issuedQuantity`. The quantity is decremented from the original inventory object. When your organization enforces pickable locations, `issueItemToKit` refuses inventory that sits at a location not marked pickable, with a `VALIDATION_ERROR`: ```json theme={null} { "errors": [ { "message": "Inventory at location 'Quarantine Cage' cannot be kitted: the location is not marked pickable.", "path": ["issueItemToKit"], "extensions": { "code": "VALIDATION_ERROR" } } ], "data": { "issueItemToKit": null } } ``` #### Kitting WIP inventory for outside processing When the organization setting `allowWipOspKitting` is on, WIP inventory can be issued to a kit if it's linked to a purchase order line through an outside processing (OSP) run step. `PartInventory.isLinkedToOspPoLine` reports that, and you can filter on it. > [!WARNING] > > **Breaking change for API consumers.** In July 2026 this field was briefly live in the API as `isLinkedToSkipInventoryPoLine`, though it never appeared in this reference's schema, and it required the purchase order line to have `skip_inventory_creation` set. It's now `isLinkedToOspPoLine`, on both `PartInventory` and `PartInventoriesInputFilters`, and it keys on the run step being marked outside processing. `skip_inventory_creation` no longer plays a part. Rename the field in any query or filter that used the old name. A query that still asks for the old field fails with `Cannot query field`. ### Move parts back to inventory Once a serial-tracked part is built, move it back to inventory for use on a higher-level assembly. Move an item back to inventory with this mutation: ```graphql theme={null} mutation MoveItemToInventory($input: InventoryToKitInput!) { moveItemToInventory(input: $input) { partInventory { id quantity partId serialNumber lotNumber location { name } partKits { id } } } } ``` Set the variables: ```json theme={null} { "input": { "quantity": 2, "partKitItemId": 1, "etag": "etag", "partInventoryId": 3 } } ``` You must include the quantity you are moving back to inventory. For a lot-tracked or untracked item, this quantity can be less than the full amount originally issued. ### Query part kits List part kits with a filter: ```graphql theme={null} query PartKits($filters: PartKitsInputFilters) { partKits(filters: $filters) { edges{ node { id run { id } partInventories { id issuedQuantity } } } } } ``` Set the filter variables: ```json theme={null} { "filters": { "runId": { "eq": 1 } } } ``` ### Update several kits in one request `updatePartKits` applies the same update path as `updatePartKit` to each item in the list, so every item carries its own `etag`: ```graphql theme={null} mutation UpdatePartKits($input: [UpdatePartKitInput]) { updatePartKits(input: $input) { partKits { id locationId deliveryLocationId status } } } ``` Set the variables: ```json theme={null} { "input": [ { "id": 1, "etag": "etag1", "locationId": 6 }, { "id": 2, "etag": "etag2", "deliveryLocationId": 5, "status": "REQUESTED" } ] } ``` ## Plan kit picks The `partKitPickList` query returns the inventory to pull to fulfill one or more kits. `pickStrategy` takes a single value, `FIFO`. `FIFO` ranks candidate inventory **site first, then receipt date**. A kit's site is the top-level ancestor of the kit's own location (`locationId`). Stock at that site ranks ahead of stock anywhere else, whatever its age, and within each site the oldest `receivedOrCreatedDate` goes first. Off-site stock is drawn on only once stock at the kit's site can't cover the line. A kit with no `locationId` has no site, so its candidates rank by receipt date alone. Eligible inventory is available stock of any part that can fulfill the kit item, net of what is already kitted. Depending on your settings, stock at locations that aren't marked pickable is excluded. ### Generate a pick list Pass `partKitIds` to plan a pick across a batch of kits. The response groups inventory into location stops in walk order, and splits each row's quantity per kit: ```graphql theme={null} query PartKitPickList($partKitIds: [ID!], $pickStrategy: PickListStrategy!) { partKitPickList(partKitIds: $partKitIds, pickStrategy: $pickStrategy) { locations { stopNumber locationId locationName inventoryRows { inventoryId partId quantityToPull kitAllocations { partKitId quantity } } } } } ``` Set the variables: ```json theme={null} { "partKitIds": ["1", "2"], "pickStrategy": "FIFO" } ``` An abridged response for three kits that each need 8 of one part and 2 of another, both stocked in one bin: ```json theme={null} { "data": { "partKitPickList": { "locations": [ { "stopNumber": 0, "locationName": "A1-01", "inventoryRows": [ { "partId": "48886", "quantityToPull": 24.0, "kitAllocations": [ { "partKitId": "60905", "quantity": 8.0 }, { "partKitId": "60906", "quantity": 8.0 }, { "partKitId": "60907", "quantity": 8.0 } ] }, { "partId": "48894", "quantityToPull": 6.0, "kitAllocations": [ { "partKitId": "60905", "quantity": 2.0 }, { "partKitId": "60906", "quantity": 2.0 }, { "partKitId": "60907", "quantity": 2.0 } ] } ] } ] } } } ``` `quantityToPull` is the total to pull from that inventory row across every kit in the request, which is the sum of its `kitAllocations`. It isn't the row's on-hand quantity. No inventory is allocated twice across the kits in one request. Pass `partKitId` instead to plan a pick for a single kit. That form returns the flat `partInventories` list, already in walk order, and `locations` is `null`. Each entry is the whole inventory record, so read the quantity to pull from the kit item rather than from `quantity`: ```graphql theme={null} query PartKitPickList($partKitId: Int, $pickStrategy: PickListStrategy!) { partKitPickList(partKitId: $partKitId, pickStrategy: $pickStrategy) { partInventories { id quantity part { partNumber } location { id name } } } } ``` Both forms rank candidates with the same site-first model, so a single-kit pick and a one-kit batch choose the same inventory. Supply exactly one of `partKitId` or `partKitIds`. Supplying both, or neither, is a validation error. `partKitIds` accepts at most 2,000 kits per request by default, and an empty list returns an empty pick list. Add the optional `locationId` argument to restrict the pick to one location and its sub-locations. Rows are item-major: each row is one inventory record, and `kitAllocations` splits it across the kits that draw on it, rather than one row per kit. Stops are ordered by the `pickSequence` on each location, which you set through `updateLocation`. Locations that carry a sequence come first, in ascending order, followed by locations with no sequence in natural name order, so `C-S-Bulk-2` precedes `C-S-Bulk-10`. Inventory with no location trails every real stop. `stopNumber` counts from 0. ### Check whether a kit can be filled `fillabilityPercent` on a part kit is the share of the kit's remaining need, from 0 to 100, that a pick list can allocate right now. `isFullyFillable` is `true` when that share is the whole remaining need. Both are filterable and sortable: ```graphql theme={null} query PartKits($filters: PartKitsInputFilters) { partKits(filters: $filters, sort: [FILLABILITY_PERCENT_DESC]) { edges { node { id fillabilityPercent isFullyFillable percentFulfilled } } } } ``` Set the filter variables: ```json theme={null} { "filters": { "fillabilityPercent": { "gte": 50 } } } ``` For a kit that the available stock covers only in part, the response reads: ```json theme={null} { "id": 60911, "fillabilityPercent": 81, "isFullyFillable": false, "percentFulfilled": 0 } ``` Both fields score one kit on its own. Kits picked together in one request share the same inventory, so a batch can allocate less than the individual scores suggest, and a pick scoped to a `locationId` can allocate less still because the score counts stock in every location. ### List the parts that can fulfill a kit item `acceptablePartIds` on a part kit item returns every part that can fulfill it, each tagged with why it qualifies: ```graphql theme={null} query PartKitItem { partKitItem(id: 123) { id acceptablePartIds { partId partIdInformation } } } ``` A kit item with one mBOM substitute returns: ```json theme={null} { "data": { "partKitItem": { "id": 110823, "acceptablePartIds": [ { "partId": 48886, "partIdInformation": "original" }, { "partId": 48923, "partIdInformation": "substitute" } ] } } } ``` `partIdInformation` takes one of four values: | Value | Meaning | | - | - | | `original` | The part the kit item asks for. | | `interchangeable_revision` | Another revision of that part number, included when part interchangeability is on. | | `substitute` | An mBOM substitute for the kit item's originating mBOM line. | | `substitute_interchangeable_revision` | Another revision of a substitute, included when part interchangeability is on. | For more information about the setting behind the two interchangeable values, see [Enable part interchangeability](/administration/supply-chain-settings/enable-part-interchangeability). # Manage parts and revisions Source: https://docs.firstresonance.io/api/guides/parts-and-part-revisioning Query, create, update, revision, and delete Parts through the ION GraphQL API, including custom revision schemes. Part objects in ION represent abstractions that carry information about a particular part, while the physical parts themselves are Inventory objects. A Part object dictates the mBOM, revision, supplier part number, tracking type, and other attributes of a part. For the full list of Part fields, see the `Part` type in the [API Reference](/api-reference/overview), or open the GraphiQL editor in ION from **Developer Platform > GraphQL**. | Part field | Description | | - | - | | `id` | Unique identifier of the Part object. | | `partNumber` | Parts must have a unique `partNumber` and `revision`. | | `revision` | Revision for the part. Defaults to A. | | `latestRevision` | The most recently created revision of the part number. A `-` revision counts only when it is the part number's only revision. | | `isLatestRevision` | `true` when this record's `revision` is the part number's `latestRevision`. | | `trackingType` | If set, enforces all inventory for the part to match the tracking type. Either `serial` or `lot`. | | `quantity` | The summed quantity of all inventory for a part. | | `partsInventory` | List of Inventory objects related to a part. | | `runs` | List of runs related to the part. | | `mbom` | List of mBOM items that describe the BOM of a part. | ## Query parts The queries below list parts by a filter or get a specific part. List parts with a filter: ```graphql theme={null} query GetParts($filters: PartsInputFilters, $first: Int) { parts(filters: $filters, first: $first) { edges { node { id partNumber description thumbnail { s3Key s3Bucket url } fileAttachments { url } quantity } } } } ``` Set the filter variables: ```json theme={null} { "filters": { "partNumber": { "eq": "ion-12" } }, "first": 10 } ``` To return only the latest revision of each part, add `"isLatestRevision": { "eq": true }` to `filters`. Get a single part by ID: ```graphql theme={null} query GetPart{ part(id: 1) { id partNumber description quantity } } ``` ## Create a part The part number and revision must be unique. If you supply no revision in the mutation, the part defaults to revision A. Once created, you cannot update the revision of a part. Instead, use the `createPartRevision` mutation to iterate a part's revision. Create the part with this mutation: ```graphql theme={null} mutation CreatePart($input: CreatePartInput!) { createPart(input: $input) { part { id revision partNumber description } } } ``` Set the variables: ```json theme={null} { "input": { "partNumber": "ion-12", "description": "Part for API docs.", "revision": "C" } } ``` > [!TIP] > > If the part you create contains custom attributes, declare the attributes when you create the part, even if an attribute contains no value. To create a part with attributes, include them in the mutation input: ```graphql theme={null} mutation CreatePart($input: CreatePartInput!) { createPart(input: $input) { part { id revision partNumber description attributes { key value } } } } ``` Set the variables: ```json theme={null} { "input": { "partNumber": "ion-12", "description": "Part for API docs.", "revision": "C", "attributes": [ { "key": "Attribute 1" }, { "key": "Attribute 2", "value": "Value for attribute 2" } ] } } ``` ## Update a part You can update the tracking type to either `serial` or `lot` only if all existing inventory objects related to the part conform to the new tracking type. Update the part with this mutation: ```graphql theme={null} mutation UpdatePart($input: UpdatePartInput!) { updatePart(input: $input) { part { id partNumber description revision } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1, "etag": "etag1", "partNumber": "ion-13", "description": "Updated part for API docs." } } ``` ## Create a part revision You can generate a revision from any part. For example, if your part "ion-13" has existing revisions A and B, you can generate a third revision C from either revision A or B. ### What the new revision copies The new revision starts as a copy of the source part. The `createPartRevision` input accepts overrides for `description`, `thumbnailId`, `supplierPartNumber`, `revisionScheme`, and `trackingType`. Everything else comes from the source part: * **Part fields.** All part fields except the ones ION sets itself: `id`, `parentId`, `revision`, `revisedFromId`, `revisionScheme`, `entityId`, the created and updated timestamps, and the created-by and updated-by users. ION sets `revisedFromId` to the source part's `id`. * **File attachments.** The new revision links to the same file attachments as the source, including link-only attachments. Both revisions share the same attachment records, so there is no second copy of the file. * **Assets, labels, and requirements.** Linked to the new revision the same way as file attachments. * **Custom attributes.** Copied with their values. * **Part subtypes and planning policy.** Copied. * **mBOM.** ION creates a new **Draft** mBOM at version 1 for the new revision. If the source part has an mBOM, ION copies the items from its latest version into it, along with each item's substitutes and reference designators. The source's status doesn't carry over, so a released mBOM on the source becomes a draft on the new revision. See [mBOM versions and release](/api/guides/mbom-versions-and-release). The new revision does not copy comments, barcode labels, or subscriptions. ### How the new revision is chosen You can't set `revision` in `createPartRevision`. ION chooses it for you: * Without `revisionScheme`, the new revision is the next revision in the part's scheme after the part number's latest revision. That is not always the source's next revision. If revisions A and B exist, B is the latest, and you revise A, the result is C. If the part's latest revision is Z, the new revision is AA. * With a `revisionScheme` that differs from the part's current scheme, the new revision is the initial revision of that scheme. See [Convert the revision scheme of an existing part](#convert-the-revision-scheme-of-an-existing-part). * If the chosen revision already exists for the part number, the mutation fails with `Revision X already exists on part Y. Choose a different revision or scheme.` ### Set a revision when you create a part If you set `revision` in `createPart`, ION checks these rules: * The revision must match the format of the part's revision scheme. The default scheme is alphabetical, so a revision such as `1` fails with `Revision 1 for part N is invalid. Must follow set revision format (ALPHABETICAL).` * The revision is not required to come after existing revisions. You can create revision C and then revision A of the same part number. * The part number and revision pair must be unique, and uniqueness ignores case. Creating `a` when `A` exists fails. * The latest revision is the most recently created one, not the highest. If you create C and then A, `latestRevision` is `A`, and a revision created from either one is `B`. A `-` revision counts as the latest only when it is the part number's only revision. * Setting a different `revisionScheme` in `createPartRevision` restarts numbering from the initial revision of the new scheme. In `updatePart`, it casts the current revision instead. Create a revision with this mutation: ```graphql theme={null} mutation CreatePartRevision($input: CreatePartRevisionInput!) { createPartRevision(input: $input) { part { id partNumber revision } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1, "etag": "etag1", "description": "New revision for part in API docs." } } ``` ## Delete a part Deleting a part cascades to delete the mBOM and mBOM substitutes associated with the part. You cannot delete a part that has existing inventory or that was used within a run. Delete the part with this mutation: ```graphql theme={null} mutation DeletePart($id: ID!, $etag: String!) { deletePart(id: $id, etag: $etag) { id } } ``` Set the variables: ```json theme={null} { "id": 1, "etag": "etag1" } ``` ## Custom part revision scheme ION lets you define custom schemes for part revisioning. You define these schemes in your organization's settings. The mutation below creates a new scheme. You first need the ID and etag of the organization before you can update its settings. Four additional variables define a part revision scheme: * **name** (string): The name of the new revision scheme. * **default** (boolean): If `true`, all newly created parts inherit this revision scheme. * **allowOverflow** (boolean): Defines whether ION raises an error when the revision scheme reaches its max iteration, or overflows to the next available value. * **format** (array of strings): Defines how the values of a revision scheme appear. The string values in the array can be `NUMERIC`, `ALPHABETICAL`, or single-character-length constants. The format below defines part revisions like `00-1` or `95-7`. Create the revision scheme with this mutation: ```graphql theme={null} mutation CreateOrganizationPartRevisionScheme( $input: CreatePartRevisionSchemeSettingInput!) { createOrganizationPartRevisionScheme(input: $input) { organization { id settings { parts { revisionSchemes { default name allowOverflow format } } } } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1, "name": "new scheme", "default": true, "format": ["NUMERIC", "NUMERIC", "-", "NUMERIC"], "etag": "etag1", "allowOverflow": true } } ``` ## Update a part revision scheme Once a part revision scheme exists in your organization's settings, you can update it. The only fields you can update on a part revision scheme are `allowOverflow` and `default`. Update the revision scheme with this mutation: ```graphql theme={null} mutation UpdateOrganizationPartRevisionScheme( $input: UpdatePartRevisionSchemeSettingInput!) { updateOrganizationPartRevisionScheme(input: $input) { organization { id settings { parts { revisionSchemes { default name allowOverflow format } } } } } } ``` Set the variables: ```json theme={null} { "input": { "id": 1, "name": "new scheme", "default": false, "etag": "etag1", "allowOverflow": false } } ``` ## Convert the revision scheme of an existing part Two strategies change the revision scheme of an existing part. Both set the `revisionScheme` for a part in either the `updatePart` or `createPartRevision` mutation above. Set `revisionScheme` to the name of one of the schemes in your organization's settings. * Setting `revisionScheme` in the `updatePart` mutation casts the part's revision. For example, if a part currently has revision `D` and you update that part to use the revisionScheme "new scheme" created above, the revision is set to `00-4`. * Setting `revisionScheme` in the `createPartRevision` mutation resets the part's revision, starting it over from the initial revision of the new scheme. If a part has revision `D` and you update the part's `revisionScheme` in the `createPartRevision` mutation, it is set to `00-1`. # Build an API client Source: https://docs.firstresonance.io/api/guides/python-quickstart A runnable Python integration template for ION: authenticate, list parts, create a run, and attach a file. ## Overview Each function in this guide maps to one ION operation that you can lift into your own codebase. The script needs two environment variables: ```bash theme={null} export ION_BASE_URL="https://api.buildwithion.com" export ION_TOKEN="" ``` Set `ION_BASE_URL` to your region's API endpoint, without `/graphql`. For the endpoint that matches your app URL, see [Getting started](/getting-started/ion-basics#ion-environments). If you don't have a token yet, see [Getting a token](/api/authentication). ## Set up the environment ```bash theme={null} python -m venv .venv source .venv/bin/activate pip install "httpx>=0.27" "tenacity>=8.0" ``` You don't need a GraphQL-specific client. `httpx` handles the transport. `tenacity` gives you declarative retry. If you prefer the `gql` library, these patterns translate directly. ## Build the client ```python theme={null} import os import httpx from typing import Any from tenacity import retry, stop_after_attempt, wait_exponential, retry_if_exception_type class IonError(RuntimeError): """Raised when ION returns errors[] in the response body.""" def __init__(self, errors: list[dict[str, Any]]): self.errors = errors super().__init__("; ".join(e.get("message", "") for e in errors)) class IonClient: def __init__(self, base_url: str | None = None, token: str | None = None): self.base_url = (base_url or os.environ["ION_BASE_URL"]).rstrip("/") self.token = token or os.environ["ION_TOKEN"] self._http = httpx.Client( base_url=self.base_url, headers={"Authorization": f"Bearer {self.token}"}, timeout=30.0, ) @retry( retry=retry_if_exception_type((httpx.HTTPError,)), stop=stop_after_attempt(3), wait=wait_exponential(multiplier=1, min=1, max=10), reraise=True, ) def _post_graphql(self, query: str, variables: dict[str, Any] | None = None) -> dict[str, Any]: r = self._http.post( "/graphql", json={"query": query, "variables": variables or {}}, ) r.raise_for_status() payload = r.json() if payload.get("errors"): raise IonError(payload["errors"]) return payload["data"] def query(self, query: str, **variables) -> dict[str, Any]: return self._post_graphql(query, variables) def mutate(self, mutation: str, **variables) -> dict[str, Any]: return self._post_graphql(mutation, variables) def close(self): self._http.close() ``` You only call `IonClient.query` and `IonClient.mutate`. `_post_graphql` handles transport-level retries for 5xx and network errors. It surfaces GraphQL-level errors as `IonError`. ## Confirm the token works Check who you are authenticated as before you do anything else: ```python theme={null} ME = """ query CurrentUser { me { id name email organization { id domain } } } """ with IonClient() as ion: me = ion.query(ME)["me"] print(f"Authenticated as {me['name']} ({me['email']}) in org {me['organization']['domain']}") ``` If this fails, see the [401 table in Error codes](/api/error-codes#401-unauthorized). The error message names the fix. ## List parts ```python theme={null} LIST_PARTS = """ query Parts($filters: PartsInputFilters, $first: Int) { parts(filters: $filters, first: $first) { edges { node { id partNumber description revision partType status partSubtypes { id name } } } } } """ with IonClient() as ion: edges = ion.query(LIST_PARTS, filters={}, first=20)["parts"]["edges"] for edge in edges: p = edge["node"] subtypes = ", ".join(s["name"] for s in p["partSubtypes"]) or "—" print(f"{p['partNumber']}\t{p['description']}\t{subtypes}") ``` ## Create a run ```python theme={null} CREATE_RUN = """ mutation CreateRun($input: CreateRunInput!) { createRun(input: $input) { run { id title status procedure { id title } partInventory { id serialNumber } } } } """ with IonClient() as ion: new_run = ion.mutate( CREATE_RUN, input={ "procedureId": 12, "partInventoryId": 9876, "title": "Build #2026-04-26 Unit 1", }, )["createRun"]["run"] print(f"Created run {new_run['id']}: {new_run['title']}") ``` Replace `procedureId` and `partInventoryId` with real IDs from your org. To find candidate procedures, see [Example requests](/api/examples). ## Submit a run step result ```python theme={null} SUBMIT_STEP = """ mutation SubmitStep($input: UpdateRunStepInput!) { updateRunStep(input: $input) { runStep { id status endTime fields { id name value } } } } """ with IonClient() as ion: result = ion.mutate( SUBMIT_STEP, input={ "id": 4567, "etag": "abc123", # required for optimistic concurrency "status": "COMPLETE", }, )["updateRunStep"]["runStep"] print(f"Step {result['id']} → {result['status']} at {result['endTime']}") ``` The `etag` field is required on update. For details, see [Etag-based concurrency](/api/data-model#etag-based-concurrency). If you get a 409, re-fetch the run step, take its new etag, and retry. ## Upload a file attachment This is the full three-step pattern from [File upload](/api/guides/file-upload): ```python theme={null} import os REQUEST_UPLOAD = """ query Upload($filename: String!) { requestFileUploadUrl(filename: $filename) { uploadUrl s3Key contentType } } """ GET_RUN_STEP_ENTITY = """ query StepEntity($id: ID!) { runStep(id: $id) { entity { id } } } """ CREATE_FILE_ATTACHMENT = """ mutation CreateAttachment($input: CreateFileAttachmentInput!) { createFileAttachment(input: $input) { fileAttachment { id filename downloadUrl } } } """ def attach_to_run_step(ion: IonClient, run_step_id: int, file_path: str) -> int: filename = os.path.basename(file_path) # 1. Get a signed upload URL upload = ion.query(REQUEST_UPLOAD, filename=filename)["requestFileUploadUrl"] # 2. PUT the file to S3, capture the ETag with open(file_path, "rb") as f: s3_response = httpx.put( upload["uploadUrl"], content=f.read(), headers={"Content-Type": upload["contentType"]}, timeout=120.0, ) s3_response.raise_for_status() s3_etag = s3_response.headers["ETag"].strip('"') # 3. Resolve the run step's entity.id (NOT the run step's own id) entity_id = ion.query(GET_RUN_STEP_ENTITY, id=run_step_id)["runStep"]["entity"]["id"] # 4. Register the attachment attachment = ion.mutate( CREATE_FILE_ATTACHMENT, input={ "filename": filename, "s3Key": upload["s3Key"], "s3Etag": s3_etag, "entityId": entity_id, "validateUpload": True, }, )["createFileAttachment"]["fileAttachment"] return attachment["id"] with IonClient() as ion: attachment_id = attach_to_run_step(ion, run_step_id=4567, file_path="./inspection.jpg") print(f"Attached file id={attachment_id}") ``` You must capture the S3 ETag. You must fetch `entity.id`, not the parent's `id`. Both are documented in [File upload](/api/guides/file-upload). ## Error handling pattern The `IonClient` raises `IonError` on GraphQL-level errors and uses `tenacity` for transport retries. Wrap your business logic in a try and except block that handles each error type: ```python theme={null} from httpx import HTTPStatusError, ConnectError def safely_create_run(ion: IonClient, **inputs) -> int | None: try: result = ion.mutate(CREATE_RUN, input=inputs) except IonError as e: # GraphQL errors[] — usually 4xx auth/permission/validation # Surface to the user; don't retry blindly print(f"ION rejected the request: {e}") return None except HTTPStatusError as e: # 5xx after retries exhausted print(f"ION 5xx after retries: {e.response.status_code}") return None except ConnectError: # Network down print("Cannot reach ION") return None return result["createRun"]["run"]["id"] ``` For the full HTTP status reference and the GraphQL `errors[]` payload shape, see [Error codes](/api/error-codes). ## Reuse fragments When several queries return the same entity, such as parts, runs, or purchase orders, define one fragment per entity and inline it everywhere: ```python theme={null} FRAGMENTS = """ fragment PartFields on Part { id partNumber description revision partType status partSubtypes { id name } } fragment RunFields on Run { id title status procedure { id title } partInventory { id serialNumber part { ...PartFields } } } """ LIST_RUNS_WITH_PARTS = FRAGMENTS + """ query Runs($filters: RunsInputFilters) { runs(filters: $filters) { edges { node { ...RunFields } } } } """ ``` This keeps field selection consistent across calls. A forgotten field, such as `_etag`, becomes a one-line fix instead of a multi-file refactor. # Create a run Source: https://docs.firstresonance.io/api/guides/runs Create a run from a procedure using the ION GraphQL API. ## Create a run The following mutation creates a run from a procedure: ```graphql theme={null} mutation CreateRun($input: CreateRunInput!) { createRun(input: $input) { run { id title procedureId createdById dueDate assignedToId description partInventory { serialNumber } } } } ``` Use these query variables: ```json theme={null} { "input": { "title": "run title", "procedureId": 1, "dueDate": "2021-09-28T16:57:37", "partInventoryId": 2 } } ``` ## Let ION generate the title Instead of sending a `title`, you can have ION build one from the organization's run title template. Set `autogenerateTitle` to `true` and omit `title`. Sending both is rejected. ```json theme={null} { "input": { "autogenerateTitle": true, "procedureId": 1, "dueDate": "2021-09-28T16:57:37", "partInventoryId": 2 } } ``` > [!NOTE] > > When your organization has **Enforce run title template** turned on in **Settings > Production > Runs**, ION always generates the title and rejects a request that sends `title`. Omit `title` from both the mutation and the query variables, or set `bypassEnforceRunTitle` to `true` to send your own title anyway. For the template itself, see [Configure run enforcement](/administration/production-settings/configure-run-enforcement). # Set up webhooks Source: https://docs.firstresonance.io/api/guides/webhooks Register, subscribe, secure, and test a webhook receiver so your service reacts to changes in ION. Webhooks let your service react to changes in ION without polling. You register a receiver, which is a URL plus a shared secret, then subscribe it to specific events. ION then posts a JSON message to your URL whenever a matching change is committed. ## When to use webhooks vs polling Use webhooks when: * Your system can accept inbound HTTP. * You want low-latency reactions to changes. * You want to avoid polling for changes. Stick with polling when: * Your system can't accept inbound HTTP. * You only need data on a schedule. * You need a pull-only model for compliance. ## How delivery works ION fires a webhook on the change itself, not on the API call that made it. Any committed change to a subscribed `(resource, action)` triggers a delivery, no matter where it came from: the GraphQL API, the ION UI, or an automated action. Once a matching change commits, ION builds one delivery per matching subscription and POSTs the JSON body to your receiver URL with the `x-ion-signature` header. A delivery succeeds when your receiver responds with the receiver's `expectedResponseCode`, which is 200 by default. Any other response code counts as a failed delivery, and so does a response that takes longer than 45 seconds. ## Event types A subscription is a `(resource, action)` pair where: * `action` is one of `CREATE`, `UPDATE`, or `DELETE`, the operation that fires the webhook. * `resource` is one of ION's webhookable entities. The schema exposes the full list: use the [API Playground](/api/playground) and inspect the `ResourceEnum` type. Common resources customers subscribe to: | Resource | Typical use case | | - | - | | `RUNS` | Track when production runs are created, updated, or completed | | `RUN_STEPS` | React when a run step is signed off, failed, or has a measurement recorded | | `PARTS` | Sync the part library into an external ERP | | `PARTS_INVENTORY` | Mirror inventory state into an MES or warehouse system | | `ISSUES` | Push quality events into a ticketing system | | `PURCHASE_ORDERS` | Notify procurement on PO state changes | | `FILE_ATTACHMENTS` | React to new uploads | `ABOM_INSTALLATIONS` is also subscribable. `ABOM_ITEMS` and `ABOM_EDGES` aren't. ## Payload shape Every delivery is a JSON POST with this shape: ```json theme={null} { "action": "update", "resource": "run_steps", "data": { "id": 1234, "status": "complete", "completed_at": "2026-04-26T19:33:42.108Z" }, "updated": { "status": "in_progress" }, "actor_id": 12, "transaction_id": "39383736353433", "squash_type": null } ``` | Field | Meaning | | - | - | | `action` | `create`, `update`, or `delete` | | `resource` | The lowercase table name of the changed record, such as `run_steps` | | `data` | The record after the change, or the deleted record for `delete`. Keys are column names, and a column with no value is `null`. `data` has no `_etag` | | `updated` | For `update`, the previous values of the fields that changed. `null` for `create` and `delete`, and for an update with no changed fields | | `actor_id` | The ID of the user who made the change | | `transaction_id` | A string that identifies the database transaction that made the change. It is the transaction ID written as text and hex-encoded. Events from the same transaction share the same ID | | `squash_type` | Only some environments include this field. Where it's present, it is `insert`, `update`, or `delete` when several changes to one record in one transaction were merged into this event, and `null` otherwise | A delivery has no ID of its own, so there is no per-delivery key to deduplicate on. See [Handle duplicate and out-of-order deliveries](#handle-duplicate-and-out-of-order-deliveries). > [!NOTE] > > Don't assume `updated` is populated. If you need the full current state of the > record, requery it through the API using `data.id`. The webhook is a change > notification, not a full snapshot. ## Signature verification Every delivery includes an HMAC signature in the `x-ion-signature` header. Verify it before trusting the payload. Anyone can reach your endpoint. Only you and ION hold the secret. The signature signs the receiver URL plus the `data` field's keys and values (alphabetically sorted, `null` values excluded), not the raw body: ```text theme={null} params = sorted_alphabetically([f"{k}:{v}" for k, v in data.items() if v is not None]) signed_data = f"{webhook_uri}?{'&'.join(params)}".encode("utf-8") signature = base64(hmac_sha1(shared_secret.encode("utf-8"), signed_data)) ``` Implement the same construction on your side and compare: ```python theme={null} import base64 import hmac import hashlib def verify_signature(secret: str, url: str, data: dict, header_signature: str) -> bool: params = [f"{k}:{v}" for k, v in sorted(data.items()) if v is not None] signed = f"{url}?{'&'.join(params)}".encode("utf-8") expected = base64.b64encode( hmac.new(secret.encode("utf-8"), signed, hashlib.sha1).digest() ).decode() return hmac.compare_digest(expected, header_signature) ``` Always use `hmac.compare_digest` or your language's equivalent. A constant-time comparison prevents timing attacks. > [!NOTE] > > ION writes each non-null `data` value into the signed string the way Python's > `str` writes it. A boolean is `True` or `False`, and a nested object is > written as a Python dictionary with single quotes. If your receiver isn't > written in Python, reproduce that format for values that aren't strings. ## Custom headers | Header | Purpose | | - | - | | `content-type` | `application/json` or `application/xml`, set by the receiver's `contentType` setting (`JSON` or `XML`). The body is always JSON | | `x-ion-signature` | HMAC signature. See [Signature verification](#signature-verification) | | Custom headers | Anything you registered with `createWebhookHeader` and `addHeaderToWebhookReceiver`, such as auth tokens for downstream gateways or routing hints | Custom headers are useful when your receiver sits behind an API gateway that requires its own auth, such as an internal API key. Create a header once, then add it to each receiver that needs it. ION attaches it to every delivery. ION lowercases header names, and you can't set `x-ion-signature` or `content-type` as a custom header. ## Delivery guarantees and retries How a failed delivery is handled depends on your ION environment: * **Retries.** In some environments, ION retries a failed delivery up to two more times, about 10 seconds apart, then stops. A delivery that fails all three attempts isn't sent again. In other environments, ION makes one attempt and doesn't retry. In both, the failed delivery stays in the delivery log with the status `FAILED`. * **Merged events.** In some environments, ION merges several changes to the same record within one transaction into one event. A record that is created and then updated arrives as one `create` that holds the final values. Several updates arrive as one `update` that holds every changed field. A chain of changes that ends in a delete arrives as one `delete`. `squash_type` tells you which merge happened. * **No ordering guarantees.** ION doesn't guarantee the order of deliveries. Events from different transactions can interleave, and a retried delivery can arrive after later ones. * **No exactly-once.** A delivery can arrive more than once, for example when your receiver processed it but answered too slowly. Build your receiver to be idempotent. > [!TIP] > > ION waits up to 45 seconds for a response. If your processing is slow, > acknowledge right away with the receiver's expected response code and queue > the work to run asynchronously downstream. ## Handle duplicate and out-of-order deliveries Treat each delivery as a notice that a record changed, not as the change itself. Requery the record by its ID and apply its current state. A handler that does this gives the same result however many times, and in whatever order, the same change arrives: ```python theme={null} def handle(event): record_id = event["data"]["id"] if event["action"] == "delete": remove_local_copy(event["resource"], record_id) else: upsert_local_copy(fetch_current_state(event["resource"], record_id)) return 200 ``` Run a periodic poll as well, so that a delivery that failed all its attempts doesn't leave your copy out of date. ## Register a receiver Webhook receivers are registered via the GraphQL API. Create the receiver first: ```graphql theme={null} mutation CreateReceiver($input: CreateWebhookReceiverInput!) { createWebhookReceiver(input: $input) { webhookReceiver { id name webhookUri sharedSecret # the HMAC key for verifying signatures contentType expectedResponseCode } } } ``` ```json theme={null} { "input": { "name": "Acme Production Pipeline", "description": "Triggers Acme ETL on run completion", "webhookUri": "https://hooks.example.com/ion-events", "contentType": "JSON", "expectedResponseCode": 200 } } ``` The `sharedSecret` in the response is your HMAC key for [signature verification](#signature-verification). If you omit `sharedSecret` on creation, ION generates one. You can also set your own, which must be at least 8 characters. You can read the secret again by querying the receiver, and change it with `updateWebhookReceiver`. `webhookUri` must use HTTPS, and a URL can belong to only one receiver. You can change it later with `updateWebhookReceiver`. ## Subscribe to events Add one or more subscriptions to the receiver. Each subscription is one `(resource, action)` tuple, and a receiver can have each tuple once: ```graphql theme={null} mutation Subscribe($input: CreateWebhookSubscriptionInput!) { createWebhookSubscription(input: $input) { webhookSubscription { id resource action active } } } ``` ```json theme={null} { "input": { "receiverId": 42, "resource": "RUN_STEPS", "action": "UPDATE", "active": true } } ``` ## Test the receiver Before pointing production traffic at a new receiver: 1. **Register against your sandbox tenant.** See the [Sandbox guide](/api/sandbox). 2. **Trigger known events.** Create, update, and delete a run step in the sandbox UI, then verify your receiver logs the deliveries. 3. **Inspect failed deliveries.** Query `webhookEvents` filtered by `subscriptionId` and the `FAILED` status to see the response code and the request and response bodies ION recorded for the latest attempt. ```graphql theme={null} query FailedEvents($subscriptionId: ID!) { webhookEvents( filters: { subscriptionId: { eq: $subscriptionId }, status: { eq: FAILED } } first: 50 ) { edges { node { id numberOfRetries responseStatusCode responseReceivedAt requestData responseData } } } } ``` `numberOfRetries` counts delivery attempts. An attempt that fails shows as `FAILED` even when ION is about to retry, and the same row updates if a retry succeeds. A delivery fails when your receiver responds with a code other than its expected response code, doesn't respond within 45 seconds, can't be reached, or presents a certificate that can't be verified. ## Monitor deliveries in ION The same delivery log is browsable in the app: in ION, go to **Developer Platform > Webhook Deliveries**. Each row is one delivery, and a retry updates its row. The response body is usually the fastest clue when a delivery fails. # MCP Source: https://docs.firstresonance.io/api/mcp-server Connect AI agents like OpenAI Codex, Claude, and Cursor to ION through the Model Context Protocol (MCP) server. The Model Context Protocol (MCP) is a standard interface that AI agents use to interact with ION. Agents like OpenAI Codex, Claude, and Cursor connect to the ION MCP server. A connected agent can query and act on your ION data in natural language. You can also build custom agents on top of ION with SDKs such as the AWS Strands SDK. > [!NOTE] > > The ION MCP server is in beta. ## Authentication The MCP server uses OAuth 2.1 dynamic client registration (DCR). You sign in with your existing ION account, and the agent acts with that account's permissions. ## MCP server URLs Each ION region runs its own MCP server. Connect to the server for the region whose app URL you sign in to. The other regions' servers don't accept your ION account. For your region's other URLs, see [ION environments](/getting-started/ion-basics#ion-environments). > [tab] US > > | Environment | MCP server URL | > | - | - | > | Production | `https://mcp.buildwithion.com/mcp` | > | Sandbox | `https://mcp.staging.buildwithion.com/mcp` | > [tab] US GovCloud > > | Environment | MCP server URL | > | - | - | > | Production | `https://mcp.gov.buildwithion.com/mcp` | > | Sandbox | `https://mcp.staging.gov.buildwithion.com/mcp` | > [tab] Australia > > | Environment | MCP server URL | > | - | - | > | Production | `https://mcp.ap.buildwithion.com/mcp` | > | Sandbox | `https://mcp.staging.ap.buildwithion.com/mcp` | The examples use the US sandbox URL. Replace it with the URL for your region and environment. ## Connect Claude You need a Claude Pro plan or above to connect to the ION MCP server. 1. In Claude, go to **Your Profile > Settings > Connectors**. Click **Add custom connector**. 2. Enter a name and the MCP server URL for your region. For example, use the name `ION-SANDBOX` and the URL `https://mcp.staging.buildwithion.com/mcp`. 3. Click **Connect**. Claude prompts you to sign in to ION. 4. Ask Claude for a list of things it can do in ION. This confirms the connection and shows you its capabilities. ## Connect Cursor 1. Open Cursor and go to **Cursor Settings**. 2. Click **Tools and MCP > Add an MCP Server**. 3. Enter this configuration. Swap the name and URL for your region and environment. You can add more than one: ```json theme={null} { "mcpServers": { "ion": { "url": "https://mcp.staging.buildwithion.com/mcp" } } } ``` 4. Turn on **Agent** mode. The chat window starts in **Ask** mode, which doesn't allow MCP servers. 5. Ask Cursor for a list of things it can do in ION. This confirms the connection and shows you its capabilities. ## Connect OpenAI Codex You need OpenAI Codex installed and signed in to connect to the ION MCP server. 1. In your terminal, add the ION MCP server with the MCP server URL for your region: ```bash theme={null} codex mcp add ion --url https://mcp.staging.buildwithion.com/mcp ``` 2. Sign in to ION through Codex: ```bash theme={null} codex mcp login ion ``` 3. Complete the ION sign-in flow in your browser. 4. Run `codex mcp list`, or use `/mcp` in the Codex terminal UI, to confirm the server is connected. 5. Ask Codex for a list of things it can do in ION. This confirms the connection and shows you its capabilities. Codex stores MCP server configuration in `~/.codex/config.toml`. The Codex CLI and Codex IDE extension use the same configuration. # API playground Source: https://docs.firstresonance.io/api/playground Explore the ION GraphQL schema, write queries, and run them against your tenant from the docs. The API playground lets you explore the ION GraphQL schema and run queries against your tenant before you write client code. Access it by going to **Developer Platform > GraphQL** on the sidebar. ## Authenticate To run a query, first set your access token in the **Authorization** header field at the top of the playground: ``` Authorization: Bearer ``` There are two ways to get a token: * **API key**: exchange it for a token through your auth provider's client-credentials grant. See [Manage API keys](/api/authentication/api-keys). * **OAuth 2.0**: complete the authorization code flow and use the resulting access token. See [Authenticate with OAuth 2.0](/api/authentication/oauth). The playground stores tokens locally in your browser and sends them only to the ION API. ## Quick start Run this query first to confirm your token works: ```graphql theme={null} query Me { me { id name email organization { id domain } } } ``` A successful response means your token is valid for the tenant in `organization.domain`. If you get an `errors[]` payload instead, see [Error codes](/api/error-codes). ## What you can do here > [!WARNING] > > The playground runs mutations against the live API. Use a [sandbox > tenant](/api/sandbox) when prototyping mutations so you don't change > production data. * **Schema explorer**: click any type to see its fields, arguments, and return types. * **Variables panel**: pass query variables as JSON instead of hardcoding them in the query body. * **History**: the playground saves every query you run locally. Re-run or share a saved query with teammates. * **Schema docs sidebar**: type `__schema` or `__type` to run an introspection query and inspect the schema. ## Example Queries and Mutations See [Example requests](/api/examples). ## GraphQL schema reference For every query, mutation, and type in the schema, see the [API Reference](/api-reference/overview). > [!TIP] > > To find which query or mutation powers a page, open your browser's developer > tools, go to the **Network** tab, and click around in ION. The app shows the > exact queries, mutations, and filters it sends. # Sandbox Source: https://docs.firstresonance.io/api/sandbox Request a non-production ION environment for integration development, learn what differs from production, and promote your integration when it's ready. A sandbox is a separate, isolated ION tenant that starts blank. Use one to build and test an integration against the ION API without affecting production. ## When to use a sandbox Use a sandbox whenever you're: * Building a new integration, such as an ETL, MES, ERP, Slack bot, or custom dashboard. * Testing destructive operations, such as bulk inventory adjustments or mass run cancellations. * Reproducing a customer support issue without touching live data. * Running automated CI tests against the API. * Onboarding a new developer who needs API access without production credentials. If you're only reading data for a one-off report or analysis, production with a read-only API key works too. If you're writing data, use a sandbox first. ## Requesting access To request a sandbox environment, contact [support](https://support.firstresonance.io) with: * Why you need a sandbox, including which integration you're building. * Who needs access, as a list of users or service accounts. A typical sandbox is provisioned within a few business days, starting as a blank org. Sandboxes don't count against your production seat license. Heavy or long-lived sandbox usage can have contract implications. The support team confirms this if it applies. ## Differences from production | Aspect | Production | Sandbox | | - | - | - | | Base URL | Your region's [API endpoint](/getting-started/ion-basics#ion-environments) | Your region's sandbox endpoint, listed alongside production in [ION environments](/getting-started/ion-basics#ion-environments) | | Auth provider | Production auth provider | A separate auth instance. **Production credentials do not work here.** | | Data isolation | Your production tenant | Fully isolated. Nothing flows between sandbox and production. | | Rate limits | Production fair-use limits | Often more relaxed. Coordinate load testing with [support](https://support.firstresonance.io). | | Feature flags | Match your tier | Can expose features early for evaluation | | Data persistence | Permanent | Can be reset on request. Sandboxes expire if dormant for long periods. | | SLA | Production SLA | None. Sandboxes are best-effort. | | Webhooks | Live to your real consumers | Configurable. The default is a sink, so test events don't reach your production consumers. | The most common stumbling block is auth credentials. API keys and OAuth apps are environment-scoped, so you have to register them inside the sandbox tenant. Production credentials used against the sandbox, or the other way around, return `401 Unauthorized`. ## What data is available A sandbox always starts as a blank org. You populate parts, procedures, and runs yourself, or request a copy of your production data from [support](https://support.firstresonance.io). Production data syncs into your sandbox on a recurring cadence, weekly or monthly, that you set up with support. A one-time or on-demand sync isn't available. ## Best practices * Seed test data programmatically. A script that creates a full part, procedure, run, and installation chain is easier to re-run than rebuilding state by hand each time the sandbox resets. * Tag webhook payloads. When testing webhooks, prefix the consumer URL or set a header such as `X-Test-Run: 1`, so your downstream system can tell sandbox-driven events apart from real ones. ## Promoting an integration from sandbox to production When your integration works in sandbox and you're ready for production: 1. **Register production credentials.** Create a new API key or OAuth app registration in the production tenant. Don't reuse sandbox credentials. 2. **Swap the environment config.** Update your service's environment variables, such as `ION_BASE_URL` and `ION_TOKEN`, to point at production. 3. **Verify with read-only operations first.** Start with `me` or a list query before any mutations. 4. **Roll out gradually.** If your integration writes to ION, ramp the volume rather than turning it on at full throughput. Watch for 4xx error rates and back off if they spike. > [!WARNING] > > Sandboxes share infrastructure with other tenants. ION throttles sustained > high-volume tests, such as 10,000 QPS. > [!NOTE] > > Your sandbox runs on ION's staging environment, which is why its URLs use a > `staging` domain prefix. "Sandbox" and "staging" refer to the same > environment. # Usage limits Source: https://docs.firstresonance.io/api/usage-limits How to read the extensions.limits block ION returns when a request crosses a guardrail, so integrations and agentic workflows can adapt before enforcement rejects the request. ## Overview ION applies fair-use guardrails to the `/graphql` endpoint so one caller's heavy queries can't degrade the API for everyone. To make guardrails **discoverable rather than surprising**, responses that touch a guardrail carry a `limits` block inside GraphQL `extensions`: ```json theme={null} { "data": { "...": "..." }, "extensions": { "limits": { "violations": [ { "rule": "max_pagination_first", "field": "parts", "actual": "N", "limit": "N", "message": "Requested first: N on 'parts' exceeds the max page size of N." } ] } } } ``` The block contains one field: * **`violations`**: a list of guardrails your request bumped against. **Only present when non-empty.** A clean request omits the block entirely. > [!NOTE] > > Static caps (page size, depth, aliases, tokens, root fields) carry `actual` and `limit` numbers as shown. Rate-limit entries carry only the rule, `retryAfter` when applicable, and a message. The underlying rate budget is plan-dependent and intentionally not published in responses; follow the guidance in `message` rather than keying off a threshold. ## When the block appears The `limits` block is part of the response `extensions`, alongside anything else ION reports there. Treat it as **optional and additive**: parse it if present, ignore it if absent. Your existing `data` / `errors` handling does not change. A guardrail surfaces one of two ways, depending on where ION is in rolling a limit out to your org: | Phase | What you get | Request outcome | | - | - | - | | **Advisory** | The condition is reported under `extensions.limits.violations` | Request still **succeeds**: `data` is returned, no `errors` | | **Enforced** | The condition is returned as a GraphQL **error** with a machine code | Request is **rejected**. See [Error Codes](/api/error-codes) | Advisory is your window to adapt a query **before** it starts getting rejected. > [!NOTE] > > A successful response with no violations carries no `limits` block. If you see `extensions.limits`, there's something to address. ## The `violations` array Each entry is an object identified by its `rule`. Every entry carries a human-readable `message`; the other fields depend on the rule family. ### Structural (query shape) Static caps on the shape of the query document: page size, nesting depth, aliases, document size, and number of top-level fields. ```json theme={null} { "rule": "max_pagination_first", "field": "parts", "actual": "N", "limit": "N", "message": "Requested first: N on 'parts' exceeds the max page size of N." } ``` | `rule` | Trips on | Fix | | - | - | - | | `max_pagination_first` / `max_pagination_last` | A `first` / `last` page size larger than allowed | Lower the page size and paginate with cursors | | `max_depth` | Selection set nested deeper than allowed | Flatten the query; fetch nested data in follow-up requests | | `max_aliases` | Too many aliased fields in one document | Split into multiple requests | | `max_tokens` | Query document too large | Break the operation up | | `max_root_fields` | Too many top-level fields in one operation | Split into multiple operations | `actual` and `limit` are always present on structural entries. `field` is included where a specific field is implicated (for example, pagination or depth) to point you at the offending part of the query. ### Rate limit A per-tenant token bucket meters sustained throughput. Because it's a throughput signal, this entry carries the retry hint you need to back off: ```json theme={null} { "rule": "rate_limit", "retryAfter": "seconds", "message": "Rate limit exceeded — retry after Ns." } ``` | Field | Meaning | | - | - | | `retryAfter` | Seconds to wait before the bucket has room again | Back off for `retryAfter` seconds, then resume. Spacing requests out helps you stay under the sustained rate. > [!NOTE] > > A `rate_limit` entry **without** `retryAfter` is a permanent block: `{ "rule": "rate_limit", "message": "Access blocked. Contact support if you believe this is in error." }`. Retrying doesn't succeed until an operator lifts the block. Surface the message to the user and contact FirstResonance support, and don't build a retry loop around it. ## What enforcement looks like When a guardrail is enforced rather than advisory, the same condition comes back as a GraphQL error carrying a machine-readable `code`, and the request is rejected. Key off `errors[].extensions.code`, not the message text: | `code` | Corresponds to | | - | - | | `QUERY_COMPLEXITY_EXCEEDED` | Any structural violation above | | `RATE_LIMITED` | A transient `rate_limit` violation. Also returns **HTTP 429** with a `Retry-After` header | | `BLOCKED` | A permanent-block `rate_limit` violation (no `retryAfter`). Returns HTTP 200 with the GraphQL error rather than HTTP 429. Retrying doesn't succeed, so contact support. | Full payload shapes and remediation live in [Error Codes](/api/error-codes). The field vocabulary matches the advisory `violations` entries, so one parser can handle both paths. ## Recommended client handling For any integration, and especially unattended or agentic workflows that generate queries dynamically: 1. **Check `extensions.limits.violations` on every response.** No `limits` block means everything is clean; if the block is present, treat each entry as a to-do before enforcement flips on. 2. **On a transient `rate_limit` (or HTTP 429), honor `retryAfter`** with backoff and jitter. Don't hot-loop. 3. **On a `rate_limit` without `retryAfter` (or the `BLOCKED` error code), stop retrying.** This is a permanent block that only lifts when an operator changes the configuration. Surface the message and contact support. 4. **On structural violations, adapt the query.** Use smaller pages, fewer fields, paginate, or split the operation. Retrying the same shape won't help. 5. **Don't hard-code specific limit values.** Structural `actual` and `limit` numbers are stable but plan-dependent; read them from the response so your client stays correct as plans evolve. # Custom analytics with the Data Connector Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards Connecting your BI tools to ION data through the Data Connector, and how to troubleshoot a dashboard that looks wrong. Built-in dashboards cover the highest-frequency questions inside ION. ## Built-in dashboards ION includes dashboards for build readiness, quality, run execution, inventory, and purchasing. They read the same live data your floor uses, so there's no nightly extract and no sync delay. Each dashboard scopes to a time window, such as the last 30 days, and to the data your role can access. ## Connect your BI tool For custom reporting in Power BI, Tableau, Looker, Sigma, or a downstream data warehouse, use the Data Connector, a read-only SQL analytics layer over your ION data. | | | | - | - | | [Data Connector](/automate-with-ion/analytics-and-dashboards/data-connector) | Connect a BI tool or warehouse to ION data through a read-only SQL analytics layer. | | [Data Products](/automate-with-ion/analytics-and-dashboards/data-products) | Curated, denormalized datasets that hide model complexity from BI users. | | [Available tables](/automate-with-ion/analytics-and-dashboards/available-tables) | The full set of views the Data Connector exposes. | | [SLAs](/automate-with-ion/analytics-and-dashboards/slas) | Replication latency from ION into the Data Connector warehouse. | For one-off questions that no dashboard answers, query the [GraphQL API](/api) directly. See [Common Queries](/api/examples) for copy-paste patterns. ## Troubleshooting > [accordion] A dashboard shows empty or unexpected data > > Work through these in order: > > 1. **Check the date range.** Dashboards scope to a time window, such as the last 30 days. An event outside the window does not appear, so widen the range to cover the period you're investigating. > 2. **Check the filters.** A filter left in place from an earlier session can hide current data. Clear the filters, confirm the data appears, then reapply only what you need. > 3. **Check your access.** A dashboard shows only the data your role can see. On a limited or test account you may genuinely have no rows, so confirm the role you're signed in with. > > If data is still missing after these checks, and others see the same gap on the same dashboard, gather the details under [When you contact support](#when-you-contact-support) and reach out to [support](https://support.firstresonance.io/). > [accordion] Autoplan figures look out of date > > Figures that depend on Autoplan, such as anticipated demand and clear-to-build, refresh when Autoplan next runs on its configured schedule, not the moment you change an input. A change to a BOM, lead time, or on-hand inventory shows up after the next run. > > When Autoplan output looks wrong, check the inputs first. BOMs, lead times, and on-hand inventory at the relevant locations are the usual cause. Wait one run after correcting an input before re-checking. > [accordion] Couldn't load users on the Data Connector page > > **Cause:** a firewall, proxy, or web filter is blocking the Data Connector host. The Data Connector pages call a different hostname from the one that serves ION, so the rest of ION keeps working. The page shows a **Couldn't load users** or **Couldn't load Data Connector status** error, and **Retry** fails the same way. > > **Fix:** ask your IT team to permit the Data Connector host that matches your ION URL. For the hosts, see [Network requirements](/automate-with-ion/analytics-and-dashboards/get-started-data-connector#network-requirements). > [accordion] Data Connector data seems stale > > The Data Connector replicates ION data into its SQL analytics layer asynchronously, so it lags live data slightly. Expected latency is governed by the [SLAs](/automate-with-ion/analytics-and-dashboards/slas). If data is missing well beyond those targets, contact support. ### When you contact support Include: * Which dashboard, as a URL or screenshot. * What you expected versus what you see, with specific numbers. * The date range and filters in effect. * When you observed it, and whether it reproduces. * For Autoplan, the input you changed and when, relative to the next run. * For the Data Connector, the exact query, its result, and the expected result. # Available tables Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/available-tables The full set of raw, cleaned, and computed tables available through the ION Data Connector. The [Data Connector](/automate-with-ion/analytics-and-dashboards/data-connector) exposes your organization's data as a set of read-only views. These views come in three tiers, listed in full below: * **Raw**: a near 1:1 replica of each ION entity, with internal system columns removed. This is the "straight data" closest to what you see in the ION app. * **Cleaned**: the same entities with First Resonance data cleanup and business logic applied (still one row per entity), suffixed `_enriched`. * **Computed**: curated, performance-optimized [Data Products](/automate-with-ion/analytics-and-dashboards/data-products) with calculations and aggregations maintained by the ION Analytics team. > [!NOTE] > > Table and column names are case-insensitive unless quoted. Names are shown here in lowercase for readability. > > The exact set of **raw** tables available to your organization depends on which ION features you use, so you'll only see views for entities that exist in your schema. The list below is the full ION entity catalog. Customers on GovCloud also have column masking policies applied to certain fields. ## Raw tables Internal system tables and change-tracking columns are excluded. > [!NOTE] > > Attribute tables (suffixed `_attributes_base`) store one row per record and attribute `key`. When you join one to its parent record, join on both the record ID and the `key`, otherwise you get a row per attribute and your results fan out. ### Parts & inventory `parts` · `part_attributes_base` · `parts_inventory` · `parts_inventories_attributes_base` · `part_inventory_history` · `part_inventory_build_requirements` · `parts_inventory_rolled_up_costs` · `part_procedures` · `supplier_parts` ### Kits `parts_kits` · `part_kit_attributes_base` · `part_kit_items` · `part_kit_item_attributes_base` · `part_kit_inventories` ### BOM & builds `mboms` · `mboms_attributes_base` · `mbom_item` · `mbom_substitute` · `abom_installations` · `build_requirements` ### Runs, procedures & steps `runs` · `runs_attributes_base` · `run_batches` · `run_steps` · `run_steps_attributes_base` · `run_steps_fields` · `run_steps_dags` · `run_step_part_inventories` · `run_step_sessions` · `procedures` · `procedures_attributes_base` · `steps` · `steps_attributes_base` · `steps_fields` ### Planning & MRP `plans` · `plans_attributes_base` · `plan_items` · `plan_inputs` · `plan_item_allocations` · `plan_item_results` · `plan_plan_items` · `mrp_jobs` ### Purchasing & receiving `purchase_orders` · `purchase_orders_attributes_base` · `purchase_order_lines` · `purchase_order_lines_attributes_base` · `purchase_order_line_inventories` · `purchase_order_approval_requests` · `receipts` · `receipts_attributes_base` · `receipt_items` · `suppliers` · `suppliers_attributes_base` ### Quality: issues, further actions, redlines & approvals `issues` · `issues_attributes_base` · `issue_approval_requests` · `issue_approvals` · `issue_disposition_types` · `issue_part_inventories` · `issue_relations` · `further_actions` · `further_actions_attributes_base` · `further_action_approval_requests` · `further_action_approval_roles` · `further_action_approvals` · `further_action_issues` · `further_action_parts` · `further_action_runs` · `redlines` · `redline_approval_requests` · `review_requests` · `step_approval_requests` ### Locations `locations` · `locations_attributes_base` ### Organization, users & access `organizations` · `users` · `user_roles` · `roles` · `teams` · `team_roles` · `team_users` ### Datagrids `datagrid_columns` · `datagrid_rows` · `datagrid_values` ### Files, labels, comments & entities `file_attachments` · `entities_file_attachments` · `labels` · `entities_labels` · `comments` · `entities` · `model_tables` ### Barcodes `barcode_labels` · `barcode_templates` ### Webhooks `webhook_receivers` · `webhook_subscriptions` ## Cleaned tables Each is suffixed `_enriched` and retains entity-level grain (one row per entity). `barcode_labels_enriched` · `barcode_templates_enriched` · `datagrid_columns_enriched` · `datagrid_rows_enriched` · `datagrid_values_enriched` · `file_attachments_enriched` · `further_actions_attributes_base_enriched` · `issue_approval_requests_enriched` · `issues_attributes_base_enriched` · `issues_enriched` · `locations_attributes_base_enriched` · `locations_enriched` · `mbom_item_enriched` · `mbom_substitute_enriched` · `mboms_attributes_base_enriched` · `mboms_enriched` · `mrp_jobs_enriched` · `organizations_enriched` · `part_attributes_base_enriched` · `part_kit_attributes_base_enriched` · `part_kit_item_attributes_base_enriched` · `part_kit_items_enriched` · `parts_enriched` · `parts_inventories_attributes_base_enriched` · `parts_inventory_enriched` · `parts_kits_enriched` · `plan_items_enriched` · `plans_attributes_base_enriched` · `plans_enriched` · `procedures_attributes_base_enriched` · `procedures_enriched` · `purchase_order_approval_requests_enriched` · `purchase_order_line_inventories_enriched` · `purchase_order_lines_attributes_base_enriched` · `purchase_order_lines_enriched` · `purchase_orders_attributes_base_enriched` · `purchase_orders_enriched` · `receipts_attributes_base_enriched` · `receipts_enriched` · `redline_approval_requests_enriched` · `redlines_enriched` · `review_requests_enriched` · `roles_enriched` · `run_batches_enriched` · `run_steps_attributes_base_enriched` · `run_steps_fields_enriched` · `run_steps_enriched` · `runs_attributes_base_enriched` · `runs_enriched` · `step_approval_requests_enriched` · `steps_attributes_base_enriched` · `steps_fields_enriched` · `steps_enriched` · `suppliers_attributes_base_enriched` · `suppliers_enriched` · `teams_enriched` · `users_enriched` · `webhook_receivers_enriched` · `webhook_subscriptions_enriched` ## Computed tables The computed tier is a set of curated, pre-joined, and aggregated datasets maintained by the ION Analytics team. For the full list with descriptions and grain, see [Data Products](/automate-with-ion/analytics-and-dashboards/data-products). # Build readiness aBOM reference Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/build-readiness-abom Column definitions for the aBOM dashboard and its CSV export in ION Analytics. The **aBOM** tab in Build Readiness shows the installation status of every part in your as-built BOMs, with cost rollups and issue counts per component. Each row is one required part within one top-level serialized assembly. To open the dashboard, go to **Analytics > Build Readiness > aBOM**. ## Filters **Part Number**: narrows all KPIs, charts, and table rows to a single top-level assembly part number. Selecting a part number resets the **Rev** and **Serial** filters. **Rev**: further narrows to a single revision of the selected assembly. Resets the **Serial** filter. **Serial**: further narrows to a single serialized instance of the selected assembly. **Hide root nodes**: when enabled, hides the row where the part is the top-level assembly itself, so the table shows only child components. ## Sub-tabs The aBOM tab contains two sub-tabs sharing the same filters: * **aBOM**: the full installation detail table with cost and linkage columns. * **Issues**: filtered to only rows that have at least one issue, with the same column set. ## KPI cards | Card | What it shows | | - | - | | Total Cost | Sum of `TOTAL_COST` across all rows in the current filter. | | Total Parts | Number of distinct top-level assembly instances in the current filter. | | Fully Installed | Number of assembly instances where `IS_FULLY_INSTALLED` is true, and the percentage of the total. | | Open Issues | Sum of `OPEN_ISSUE_COUNT` across all rows. | ## Table columns | Column | Export field | Description | | - | - | - | | Top Level Part | `TOP_LEVEL_PART_NUMBER` | The part number of the top-level serialized assembly this row belongs to. | | Top Level Rev | `TOP_LEVEL_REVISION` | | | Top Level SN | `TOP_LEVEL_SERIAL_NUMBER` | | | Top Level Status | `TOP_LEVEL_STATUS` | The inventory status of the top-level assembly (the same status values used across ION inventory). | | Level | `MIN_LEVEL` | The BOM level of this component (0 = the top-level assembly itself). | | Parents | `PARENTS` | The parent assemblies of this component in the aBOM hierarchy. Expand the cell to see each parent's part number, revision, trace, level, and path. | | Required Part | `REQUIRED_PART` | The part number required at this position in the aBOM. | | Required Rev | `REQUIRED_PART_REVISION` | The revision of the required part as specified in the aBOM. | | Sourcing | `SOURCING_STRATEGY` | How the part is sourced: **buy** (purchased) or **make** (manufactured in-house). | | Installed Part | `INSTALLED_PART` | The part number of the inventory unit that was actually installed. | | Installed Rev | `INSTALLED_PART_REVISION` | | | Installed Trace | `INSTALLED_PART_TRACE` | The serial or lot number of the installed inventory unit. | | Req Qty | `TOTAL_REQ_QUANTITY` | The total quantity required at this BOM position. | | Installed Qty | `INSTALLED_QUANTITY` | | | Installed | `IS_FULLY_INSTALLED` | Whether the required quantity at this position has been fully installed. | | BOM Cost | `PART_COST` | The cost of this part as defined in the part library. | | Unit Cost | `UNIT_COST` | The cost recorded on the part inventory line. | | Avg Cost | `AVG_COST` | The average cost of this part across purchase orders. | | Total Cost | `TOTAL_COST` | The total cost for this row, based on the installed quantity and unit cost. | | Open Issues | `OPEN_ISSUE_COUNT` | | | Total Issues | `TOTAL_ISSUE_COUNT` | The total number of issues linked to this component, including closed ones. | | Linked Runs | `LINKED_RUNS` | Runs associated with this component. Expand the cell to see run ID, status, and due date. | | Linked POs | `LINKED_POS` | Purchase order lines associated with this component. Expand the cell to see PO number, position, quantity, cost, line status, PO status, and estimated arrival. | | Installed At | `INSTALLED_TIME` | | ## Export The **aBOM** sub-tab and the **Issues** sub-tab each have their own export. Click **Export** in the table toolbar to download the current view as a CSV. Both exports respect all active filters; the Issues export additionally filters to rows with at least one issue. # Build readiness mBOM reference Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/build-readiness-mbom Column definitions for the mBOM dashboard and its CSV export in ION Analytics. The **mBOM** tab in Build Readiness shows inventory coverage for each part required by your manufacturing BOMs. Each row is one part in one assembly context. The table and its export use the same column set. To open the dashboard, go to **Analytics > Build Readiness > mBOM**. ## Filters **Part Number**: narrows every KPI, chart, and table row to a single top-level assembly. Selecting a part number also resets the **Rev** filter to show only revisions of that assembly. **Rev**: further narrows to a single revision of the selected assembly. **Rev Match**: filters rows by whether the available inventory revision matches the BOM revision. Pick **All**, **Match**, or **Cross-Rev**. **Cross-Rev** shows only rows where the revisions do not match. Cross-rev inventory cannot be used to fulfill the BOM requirement. ## KPI cards | Card | What it shows | | - | - | | Average Readiness | Average `READINESS_PCT` across all assemblies in the current filter. | | Short Parts | Number of distinct parts with insufficient available inventory to meet their required quantity. | | Shortage Cost | Total cost value of the shortfall across all short parts. | | Ready to Build | Number of assemblies at 100% readiness out of the total assemblies in the current filter. | | Max Builds | The maximum number of complete assemblies buildable from current available inventory, constrained by the most limited part. | ## Table columns | Column | Export field | Description | | - | - | - | | Assembly | `TOP_LEVEL_PART_NUMBER`, `TOP_LEVEL_REVISION` | The top-level assembly this row rolls up to. | | Parent Assembly | `PARENT_ASSEMBLY` | The immediate parent assembly of the part in the BOM hierarchy. | | Parent Rev | `PARENT_REVISION` | | | Parent mBOM Version | `PARENT_MBOM_VERSION` | | | Part | `PART_NUMBER` | | | Part Tree | `PART_TREE` | The full BOM path from the top-level assembly down to this part. | | BOM Rev | `BOM_REVISION` | The revision of the part as specified in the BOM. | | Inv Rev | `INVENTORY_REVISION` | The revision of the available inventory for this part. | | Rev Match | `BOM_REVISION_MATCH` | Whether the inventory revision matches the BOM revision. A **Cross-Rev** result means the inventory cannot be used to fulfill this requirement. | | Description | `DESCRIPTION` | | | Sourcing | `SOURCING_STRATEGY` | How the part is sourced: **buy** (purchased) or **make** (manufactured in-house). | | mBOM Qty | `MBOM_QUANTITY` | | | Qty Required | `TOTAL_REQ_QUANTITY` | The total quantity required across all demand for this part in the current assembly context. | | Qty Available | `QUANTITY_AVAILABLE` | Quantity in inventory with status **Available**. | | Qty On Order | `QUANTITY_ON_ORDER` | Quantity on open purchase orders, not yet received. | | Shortage | `SHORTAGE_QTY` | The quantity shortfall: `TOTAL_REQ_QUANTITY − QUANTITY_AVAILABLE` when availability is insufficient, otherwise zero. | | Material Cost | `TOTAL_MATERIAL_COST` | Total cost of the required quantity at the part's unit cost. | | Shortage Cost | `SHORTAGE_COST` | Cost value of the shortage quantity. | | Readiness | `READINESS_PCT` | The percentage of the assembly's total required quantity covered by available inventory. Calculated as the sum of fulfillable quantities across all parts divided by the total required quantity across all parts. For example, if an assembly requires 7 total units across four parts and 4 units are available, readiness is 57%. | | Max Builds | `MAX_BUILDS_FROM_AVAILABLE` | `QUANTITY_AVAILABLE / TOTAL_REQ_QUANTITY`. The number of times this part's requirement can be met from available inventory. The assembly-level maximum builds is the minimum of this value across all parts. | | Level | `LEVEL` | The BOM level of this part (0 = top-level assembly). | | Short | `IS_SHORT` | Whether this part has insufficient available inventory to meet its required quantity. | | Subs | `HAS_SUBSTITUTES`, `SUBSTITUTE_COUNT` | Whether approved substitutes exist for this part, and how many. | | Unit Cost | `UNIT_COST` | The unit cost of the part from the part library. | | Procedures | `PROCEDURES` | Procedures linked to this part in the part library. Expand the cell to see procedure name, version, and status. | | Suppliers | `SUPPLIERS` | Supplier records linked to this part. Expand the cell to see supplier name, supplier part number, and cost. | ## Export Click **Export** in the table toolbar to download the current view as a CSV. The export respects all active filters. # Build readiness plans reference Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/build-readiness-plans Column definitions for the Plans dashboard and its CSV export in ION Analytics. The **Plans** page in Analytics shows supply coverage for each part across your Autoplan plans. Each row is one part in one plan. The table and its export use the same column set. To open the dashboard, go to **Analytics > Build Readiness > Plans**. ## Filters **Plan**: narrows every KPI, chart, and table row to a single plan. Select a plan from the dropdown or leave it set to **All plans** to see the combined view. ## KPI cards | Card | What it shows | | - | - | | Overall Fulfillment | `(QTY_ON_HAND + QTY_COMPLETE) / QTY_TOTAL`, expressed as a percentage, across all rows in the current filter. | | Plans | The number of distinct plans in the current filter. | | On Hand, WIP, On Order | Totals of the matching columns. | | Planned | Sum of `QTY_PLANNED` across all rows. Parts with a non-zero **Planned** value need a purchase order or a run to be created. | ## Table columns | Column | Export field | Description | | - | - | - | | Plan | `PLAN_ID`, `PLAN_DESCRIPTION` | The plan this row belongs to. | | Part | `PART_NUMBER`, `REVISION` | The part number and revision required by the plan. | | Description | `DESCRIPTION` | | | Sourcing | `SOURCING_STRATEGY` | How the part is sourced: **buy** (purchased) or **make** (manufactured in-house). | | Total Qty | `QTY_TOTAL` | Total quantity requested by kits, plans, and other demand sources for this part. This is the denominator for both percentage columns. | | On Hand | `QTY_ON_HAND` | Quantity in inventory with status **Available**. | | WIP | `QTY_WIP` | Quantity in inventory with status **WIP**. | | On Order | `QTY_ON_ORDER` | Quantity in inventory with status **On Order**. | | Planned | `QTY_PLANNED` | Quantity originally planned on runs. This value is static: adjusting a run's quantity does not update it. | | | `QTY_PLAN_INPUT` | Quantity recorded as an Autoplan input for this part. | | | `QTY_COMPLETE` | Quantity that has been kitted. | | Fulfilled | `PCT_FULFILLED` | `(QTY_ON_HAND + QTY_COMPLETE) / QTY_TOTAL`. Represents how much of the total demand is either available in inventory or already kitted. | | | `PCT_ON_HAND` | `QTY_ON_HAND / QTY_TOTAL`. The share of demand covered by available inventory alone, excluding kitted quantities. | | PO Supplier | `PO_SUPPLIER`, `PO_ESTIMATED_ARRIVAL` | The supplier on the linked purchase order and the estimated arrival date, if a PO exists. | > [!NOTE] > > A blank **Column** field means the field appears in the CSV export but not in the on-screen table. ## Export Click **Export** in the table toolbar to download the current view as a CSV. The export respects the active plan filter, so exporting with a plan selected downloads only that plan's rows. # Build your first dashboard with Superset Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/build-your-first-dashboard-with-superset Connect a BI tool to the Data Connector and build a working chart, start to finish. This guide goes end to end with Apache Superset, an open-source BI tool you can install yourself. The Data Connector works the same way with Power BI, Tableau, Looker, and Sigma, so the steps translate: only the field names and the chart editor differ. ## Before you start You need a Data Connector account and a warehouse that's already been set up for your organization. For both, see [Get started with the Data Connector](/automate-with-ion/analytics-and-dashboards/get-started-data-connector). You also need Superset running, with the Snowflake driver installed. For installation, see the [Apache Superset documentation](https://superset.apache.org/docs/installation/docker-compose). ## Connect Superset to the Data Connector This guide signs in with your own username and password, which is the quickest way to get a first chart on screen. > [!TIP] > > For a dashboard other people rely on, use a BI service user instead. It authenticates with a key pair, so the connection doesn't depend on one person's account or break when they change their password. For the steps, see [Connect a BI tool](/automate-with-ion/analytics-and-dashboards/get-started-data-connector#connect-a-bi-tool). 1. In ION, go to **Data Connector > BI service users** and find the **Connection details** card. Keep it open: you copy four values from it. 2. In Superset, go to **Settings > Database Connections** and select **Database** to start a new connection. 3. Select **Snowflake** from the **Supported databases** list. 4. Fill in the form: | Field | Value | | - | - | | **Database name** | **Database** from the Connection details card | | **Username** | your Data Connector username, which is your email address | | **Password** | your Data Connector password | | **Display Name** | any name you choose, such as `ION Data Connector` | | **Account** | **Server** from the Connection details card, with the `.snowflakecomputing.com` suffix removed | | **Warehouse** | **Warehouse** from the Connection details card | | **Role** | **Role** from the Connection details card | 5. Select **Connect**. > [!NOTE] > > The form has no schema field, so the **Schema** value from the Connection details card has nowhere to go here. You set it on each dataset instead. ## Create a dataset A dataset is the query behind a chart. Creating one from the **Datasets** page only points at whole tables, so anything with a join, a filter, or a `GROUP BY` starts in SQL Lab. 1. In Superset, go to **SQL > SQL Lab**. 2. Select your database, then select the schema, using the **Schema** value from the Connection details card in ION. 3. Enter a query. This one ranks suppliers by how many open purchase order lines are past due: ```sql theme={null} select supplier_name, count(*) as po_lines, sum(case when is_past_due then 1 else 0 end) as late_lines, round(avg(days_past_due), 1) as avg_days_late from purchase_order_tracker where is_open group by 1 having count(*) >= 3 ``` 4. Select **Run**. 5. In the query toolbar, select **Save dataset**, name the dataset, and save it. > [!TIP] > > `purchase_order_tracker` is a [Data Product](/automate-with-ion/analytics-and-dashboards/data-products): a view First Resonance maintains that has the joins and the common measures already calculated, including `is_past_due`, `days_past_due`, and `outstanding_value`. Starting from a Data Product saves you rebuilding those joins, and keeps one row per purchase order line so your counts don't inflate. ## Label the columns Unquoted names come back in uppercase, so a column you wrote as `avg_days_late` reads as `AVG_DAYS_LATE` on every axis and in every menu. Rather than quoting the names in your query, which forces you to quote every later reference, set a label on each column: 1. On the dataset, select **Edit**. 2. On the **Columns** tab, expand a column and enter a **Label**, such as `Avg days late`. 3. Repeat for each column you plan to chart, then save. ## Build a chart 1. In Superset, go to **Charts** and select **Chart** to open the chart builder. 2. Select your dataset, choose **Bar Chart**, and select **Create new chart**. 3. In **X-axis**, add your supplier column. 4. In **Metrics**, add your average-days-late column. 5. Select **Update chart**, then **Save**. > [!NOTE] > > A metric has to be an aggregate. Your query already returns one row per supplier, so an aggregate such as `MAX` returns that row's value rather than combining rows. Leave **Dimensions** empty. That control splits each bar into a series, which isn't what you want here. ## Add the chart to a dashboard 1. In Superset, go to **Dashboards** and select **Dashboard** to create one. 2. Name the dashboard. 3. Drag your chart from the chart list onto the canvas. 4. Select **Save**. ## Troubleshooting > [accordion] Snowflake isn't offered as a database type > > The database picker shows a few types as tiles and keeps the rest in the **Supported databases** list below them. Select Snowflake from that list. > > If Snowflake isn't in the list either, the Snowflake driver isn't installed in your Superset environment. > [accordion] Could not connect to Snowflake backend > > The error names your firewall and allowlist, but the usual cause is the **Account** value. Remove the `.snowflakecomputing.com` suffix from the **Server** value and try again. > [accordion] Object does not exist on a table you can see > > The query ran without a schema. Select the schema in SQL Lab, or write the table name in full as `database.schema.table`. > > This error reads like a permissions problem, so check the schema before you ask for access. > [accordion] A chart waits a long time on its first load > > The warehouse suspends when it's idle and resumes on the next query. The first query after a quiet period waits for that, and later queries are faster. # Data Connector Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/data-connector Connect ION data to external BI tools and data warehouses via a read-only SQL analytics layer. The **Data Connector** is a read-only SQL analytics layer that mirrors your operational data, making the same data ION runs on queryable from any BI tool (such as Power BI, Tableau, Looker, or Sigma) or downstream warehouse. You can tie ION data together with ERP, timekeeping, or other systems and run advanced analyses without going through the application UI. Select **Data Connector** in the ION sidebar to set up and manage your connection. When you complete onboarding, you become an admin, so you can [add users and reset their passwords](/automate-with-ion/analytics-and-dashboards/manage-data-connector-users), [create BI service users](/automate-with-ion/analytics-and-dashboards/get-started-data-connector#connect-a-bi-tool) for tools and scripts, and open the warehouse to run SQL directly, all without filing a support request. ## What's in the replica The connector exposes three tiers of tables: raw (a near 1:1 replica of each ION entity), cleaned (the same entities with cleanup applied, suffixed `_enriched`), and computed [Data Products](/automate-with-ion/analytics-and-dashboards/data-products) that pre-join and aggregate common views. For the tier definitions and the complete list of tables, see [Available tables](/automate-with-ion/analytics-and-dashboards/available-tables). For replication latency, see [SLAs](/automate-with-ion/analytics-and-dashboards/slas). # Data Products Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/data-products Curated datasets maintained by First Resonance that pre-join and aggregate the most common analytics views. **Data Products** are views maintained by First Resonance that pre-join and aggregate common queries, so you don't rebuild the same multi-table joins in every dashboard. Each data product is delivered as a queryable view inside the [Data Connector](/automate-with-ion/analytics-and-dashboards/data-connector). Use them as the source for your BI dashboards, such as Power BI, Tableau, Looker, or Sigma, or for downstream pipelines. Refresh latency follows the standard Data Connector [SLAs](/automate-with-ion/analytics-and-dashboards/slas). > [!NOTE] > > Data Products are part of the Data Connector offering. If you don't see them in your warehouse yet, contact your Customer Success Manager about enabling the Data Connector for your organization. Data Products are the **computed** tier of the Data Connector. For the raw and cleaned (`_enriched`) tiers, a near 1:1 replica of every ION entity, see [Available tables](/automate-with-ion/analytics-and-dashboards/available-tables). ## All data products The complete set of computed views available through the connector. The most commonly used products are documented in detail below. | Table | Description | Grain | | - | - | - | | `abom_baseline` | Parts installed on each assembly, from aBOM installations | Top-level inventory record and installed inventory record | | `autoplan_plan_item_results` | Autoplan results grouped by plan item (what to make or buy, quantity, due dates) | Plan item | | `autoplan_results_by_plan_input` | Autoplan progress and status by plan input | Plan input and part | | `build_completion` | Remaining work on in-progress assemblies, and requirements with no matching demand | Top-level inventory record and required part | | `build_status` | Autoplan build status by plan and part, with supply counts by type | Plan and part number | | `costed_abom` | Required against installed parts at the assembly level, with cost | Top-level inventory record, required part, and installed inventory record | | `full_bom` | Planned and completed work combined for a full production picture | Assembly and component | | `inventory_expiring` | Inventory lines that carry an expiration date, bucketed by how soon they expire | Inventory record | | `inventory_health` | One row per inventory record, with its primary purchase order line | Inventory record | | `inventory_reorder_tracking` | Reorder actions by part, with on-hand and on-order quantities | Part and revision | | `inventory_transaction_history` | Inventory transactions with part, location, and user context | Transaction | | `issue_details` | Issues with status plus related redlines and further actions | Issue, expanding with part and PO context | | `labor_hours` | Run-step durations from start and end times, by run, location, and user | Run step | | `manufacturing_readiness` | mBOM readiness for assemblies: shortages, availability, and buildable quantities | Top-level part, required part, and inventory part | | `part_kit_item_fulfillment` | Kit item fulfillment status | Kit and kit item | | `part_lifecycle_stage` | Parts by supply chain stage, with up to four rows per part | Part number and stage | | `part_quantities_by_inv_status` | Part quantity by inventory status (Available, WIP, Installed, and others) | Part | | `part_substitutes` | Approved part substitution map | Part, substitute part, and mBOM item | | `planned_bom` | Recursive planned BOM explosion from MRP and Autoplan demand | Plan input and part | | `purchase_order_receipts` | Receipt detail, one row per line received | Receipt item | | `purchase_order_tracker` | Purchase order lines with receiving, inventory, and lateness already calculated | Purchase order line | | `quality_metrics` | Issue-level quality tracking with aging, dispositions, and Further Actions (CAPA) metrics | Issue | | `query_execution_by_workbook` | Query execution metrics per analytics workbook | Workbook | | `recursive_abom` | Recursive aBOM explosion | Assembly and component | | `recursive_mbom` | Recursive mBOM explosion | Assembly and component | | `run_execution` | Run summaries with step and labor metrics already aggregated | Run | > [!NOTE] > > The set available to your organization depends on which ION features you use. A data product for a feature you don't use returns no rows. ## Kitting data products These data products cover parts, substitutions, inventory, and fulfillment in the kitting process. ### `part_kit_item_fulfillment` **Unique key:** `(part_kit_id, part_kit_item_id)` Fulfillment status for each item in a kit. It joins the `part_kit` structure with the individual `part_kit_items` and tracks whether each component has been sourced, picked, staged, or installed. Use it to monitor kit readiness and find staging or fulfillment bottlenecks before work begins. ### `part_substitutes` **Unique key:** `(part_id, substitute_part_id, mbom_item_id)` Approved substitute parts for a given `part_id` within the context of a specific `mbom_item_id`. It merges two sources of substitution logic: engineering-driven mBOM alternatives and operations-driven part interchangeability mappings. Planners and operators use it to choose a substitute when the primary part is unavailable or low in inventory. ### `part_quantities_by_inv_status` **Unique key:** `(part_id)` Current inventory for each part, grouped by inventory `Status` (Available, Quarantined, Installed, and others). It shows how much of each part is usable versus allocated, blocked, or consumed. Join it with demand metrics to flag low-availability parts. ## BOM data products ### `full_bom` A flattened, multi-level BOM rollup for fast querying of supply chain and planning data. Dashboards that previously joined the BOM tree at query time, such as Clear to Build, can read directly from `full_bom` for faster load times. To use Notable Assembly with `full_bom`: * Define a "Notable Assembly" attribute at the part library level (text or single-select). * Populate the attribute on the parts you want flagged. * Configure the attribute name in your Clear-to-Build reporting setup. ### `manufacturing_readiness` **Unique key:** `(top_level_part_id, part_id, inventory_part_id)` mBOM readiness for each assembly: what the build requires, what's available, what's short, and how many complete builds the parts on hand allow. Junction tables such as purchase order lines and kit items are aggregated before the join, so a required part stays one row per assembly. Use it for Clear to Build reporting when the demand comes from mBOMs. When the demand comes from Autoplan instead, use `build_status` or `autoplan_results_by_plan_input`. ## Purchasing data products These data products cover purchase orders, receiving, and supplier delivery performance. ### `purchase_order_tracker` **Unique key:** `(purchase_order_line_id)` One row per purchase order line, with the receiving and inventory joins already done and the common measures already calculated: whether a line is open, whether it's past due and by how many days, the quantity and percentage received, the value still outstanding, and the supplier's on-time delivery rate and average lead time. Use it for supplier scorecards, open-order reports, and past-due queues without joining purchase orders, lines, receipts, and inventory yourself. Receipts and inventory links are aggregated per line, so a line that was received in three shipments is still one row. ### `purchase_order_receipts` **Unique key:** `(receipt_item_id)` One row per line received, with the part, supplier, and purchase order context attached. Use it to analyze receiving activity over time. To report on ordering rather than receiving, use `purchase_order_tracker`. ## Inventory data products ### `inventory_health` **Unique key:** `(part_inventory_id)` One row per inventory record, with its part, location, status, and cost, plus the purchase order line it came from. Use it for inventory valuation and on-hand reporting. ### `inventory_expiring` **Unique key:** `(part_inventory_id)` Inventory records that carry an expiration date, each bucketed by how close that date is to today. Records with no expiration date are excluded. Use it to find stock that needs to be consumed or scrapped. > [!NOTE] > > The expiration buckets are calculated against the date the query runs, so a record moves between buckets over time and a saved result doesn't stay accurate. ### `inventory_reorder_tracking` **Unique key:** `(part_id, revision)` Reorder position for each part revision, combining on-hand and on-order quantities with demand. Use it to decide what to buy next. ## Issue data products These data products cover manufacturing issue tracking, triage, and resolution. They unify run, step, part, and supplier context with workflow signals such as labels, redlines, related issues, and approvals. ### `issue_details` **Unique key and grain:** * Primary grain: one row per issue (`issue_id`). * When an issue is linked to part inventory or PO line information, the grain expands. In those cases, treat the compound grain as `(issue_id, part_inventory_id, purchase_order_line_id)`. * If your dashboard expects one row per issue, either filter to the desired part or PO context, or aggregate back to the issue level. A pre-joined dataset that centralizes the most commonly used fields for issue analysis: assignment, lifecycle timestamps, run and step context, related parts and inventory, supplier and PO traceability, labels, redlines, related issues, approval-based resolution date, further-action rollups, attachments, and freshness signals such as days since last update. Use it for issue queues, SLA tracking, and continuous-improvement dashboards. # Get started with the Data Connector Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/get-started-data-connector Connect your BI tool to ION's Snowflake replica and build your first dashboard. The Data Connector gives you a read-only Snowflake account that mirrors your ION data, so you can query it from Power BI, Tableau, Looker, Sigma, or any other BI tool. ## Set up the Data Connector Select **Data Connector** in the ION sidebar. The first person from your organization to complete onboarding becomes an admin and can add the rest of the team. > [!NOTE] > > If you don't see the **Data Connector** page, your organization hasn't been onboarded yet. Contact your Customer Success Manager to enable it. The Data Connector page has cards for opening your warehouse (**Go to Data Connector**), managing who has access (**Manage users**), and creating connections for BI tools (**BI service users**). ## Network requirements The Data Connector pages call a different hostname than the rest of ION. Some networks restrict outbound traffic by hostname through a firewall, proxy, or web filter. On such a network, permit the Data Connector host for your environment, in addition to the host that serves ION. For each environment's Data Connector host, see [ION environments](/getting-started/ion-basics#ion-environments). Traffic goes over HTTPS on port 443. ## Sign in to your account Your Data Connector account is separate from your ION login. Your ION email and password, or your SSO sign-in, won't work here. * **Username**: your email address. To confirm the exact username, open **Manage users** on the Data Connector page. * **Password**: set through the one-time link you receive when your account is created. To open your warehouse, select **Go to Data Connector**. The Snowflake sign-in opens in a new tab. > [!NOTE] > > Password resets happen on the Data Connector page in ION, not on the warehouse sign-in page. An admin resets it under **Manage users**. For the steps, see [Manage Data Connector users](/automate-with-ion/analytics-and-dashboards/manage-data-connector-users). ## Connect a BI tool BI tools and scripts connect through a **BI service user**, which authenticates with a key pair instead of a password. You generate the key pair yourself and share only the public half, so your private key never leaves your machine. ### Generate a key pair Run these commands to create a private key (`rsa_key.p8`) and its matching public key (`rsa_key.pub`): ```bash theme={null} openssl genrsa 2048 | openssl pkcs8 -topk8 -inform PEM -nocrypt -out rsa_key.p8 openssl rsa -in rsa_key.p8 -pubout -out rsa_key.pub ``` > [!WARNING] > > Keep `rsa_key.p8` private. Your BI tool needs it, and anyone who has it can read your data. ### Create the BI service user On the Data Connector page, select **BI service users**, then **Add service user**. Enter a **Label** to identify the connection, such as `Tableau Production`, paste the contents of `rsa_key.pub` into **Public key (PEM)**, and select **Create service user**. ION shows the generated **Username**, such as `SVC_TABLEAU_PRODUCTION`. Note it for the next step. Creating a service user requires admin access. If you're not an admin, ask one to create it for you. ### Configure your BI tool Open the Snowflake connector in your BI tool and choose key-pair authentication: * **Username**: the service user's username. * **Private key**: your `rsa_key.p8` file. * **Server, warehouse, database, schema, and role**: read them from the **Connection details** card on the **BI service users** page. **Server** is given as the bare host, with no `https://` prefix. A value your organization doesn't have is left out of the card. > [!WARNING] > > Some tools ask for an account identifier rather than a server, in a field named **Account**. For those, remove the `.snowflakecomputing.com` suffix from **Server** and enter what's left. Keeping the suffix produces a connection error that names your firewall and allowlist, so check the value before you change any network settings. The exact steps vary by tool: * [Power BI Snowflake connector](https://learn.microsoft.com/en-us/power-query/connectors/snowflake) * [Tableau Snowflake connection](https://help.tableau.com/current/pro/desktop/en-us/examples_snowflake.htm) * [Looker Snowflake dialect](https://cloud.google.com/looker/docs/db-config-snowflake) * [Sigma Snowflake connection](https://help.sigmacomputing.com/docs/connect-to-snowflake) To roll a key, select **Rotate key** on the service user and paste a new public key. The old key stops working right away, so update your BI tool with the matching new private key before you rotate. ## Build your first dashboard The fastest way to build a useful dashboard is to start with a [Data Product](/automate-with-ion/analytics-and-dashboards/data-products) rather than the raw tables. Data Products are pre-joined, pre-aggregated views maintained by First Resonance. For a worked example from connection to a finished chart, see [Build your first dashboard with Superset](/automate-with-ion/analytics-and-dashboards/build-your-first-dashboard-with-superset). A good starting point for most teams: 1. In your BI tool, open the Snowflake connection and browse to the schema. 2. Find the **computed** tier, which holds the Data Products. 3. Drag in the Data Product that matches your question. For a quality dashboard, start with `issue_details`. For a production overview, start with `full_bom`. For part availability, start with `part_quantities_by_inv_status`. 4. Add filters for date range, team, or part as needed. > [!NOTE] > > The Data Connector is read-only. Build measures and calculated fields in your BI tool. You can't create tables or write data in the warehouse. If no Data Product fits your question, you can query the raw or cleaned (`_enriched`) tables directly. See [Available tables](/automate-with-ion/analytics-and-dashboards/available-tables) for the full catalog. # Manage Data Connector users Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/manage-data-connector-users Add Data Connector users, reset their passwords, and control admin access from the Data Connector page. Control who can query the Data Connector from the **Manage users** page. Select **Data Connector** in the ION sidebar, then **Manage users**. Managing users requires admin access, which you get by completing onboarding. ## Add a user 1. On the **Manage users** page, select **Add user**. 2. Select the person from the list. Only active ION users in your organization are eligible. If someone is missing, [invite them to ION](/administration/users-and-permissions/invite-a-user) first. 3. Optional: select **Grant Data Connector admin (CUSTOMER_ADMIN)** to let them manage users too. 4. Select **Create user**. ION generates a one-time password link for the new user. The link is emailed to them, or shown to you once to share if email delivery isn't available. It expires in 4 hours. If it lapses, reset the password to generate a new one. > [!NOTE] > > The password email comes from `support@firstresonance.io`. IT teams: allowlist this address so account and reset emails are delivered. ## Reset a password Data Connector passwords are reset from ION, not from the warehouse sign-in page. On the **Manage users** page, select **Reset password** next to the user. ION generates a fresh one-time link and re-sends it. The user follows the link to set a new password. ## Grant or revoke admin An admin can manage users and create BI service users. To change someone's access, select **Make admin** or **Revoke admin** next to the user. ## Deactivate or reactivate a user To remove someone's access, select **Deactivate** next to the user and confirm. They lose access to the Data Connector right away. Select **Reactivate** to restore it. # SLAs Source: https://docs.firstresonance.io/automate-with-ion/analytics-and-dashboards/slas Replication latency targets between ION and the Data Connector's read-only warehouse. The [Data Connector](/automate-with-ion/analytics-and-dashboards/data-connector) replicates your ION data into a read-only SQL analytics layer for custom reports and dashboards. The replica is tiered: 1. **Base tables** generated from the raw replicated data. 2. **Enriched tables and [Data Products](/automate-with-ion/analytics-and-dashboards/data-products)**: transformations layered on top of the base tables to provide aggregated and pre-joined views. Because replication runs asynchronously, there's a small delay between when a change is made in ION and when it appears in the warehouse. First Resonance commits to the following SLAs: | Tier | P99 latency | | - | - | | Base table delay (raw replicated data) | within **5 minutes** | | Enriched table / data product delay (transformations applied on top) | within **30 minutes** | ## Data integrity Distributed systems carry a non-zero probability of dropping an update during replication. We run integrity checks that detect missed updates and refresh the affected state automatically. # Build readiness Source: https://docs.firstresonance.io/automate-with-ion/analytics/build-readiness mBOM readiness and shortages, as-built installation progress, and plan fulfillment across supply statuses. In ION, go to **Analytics > Build Readiness**. The surface has three sub-tabs: **mBOM**, **aBOM**, and **Plans**. Use it to answer: can I build this assembly today, what is short and what does the shortage cost, how far along is each as-built unit, and how fulfilled is each plan. Each detail table has an **Export** control that exports the table, with its current filters applied, to CSV. ## mBOM The default sub-tab measures whether stock covers each assembly's mBOM. Filter by top-level **Part Number**, **Rev**, and **Rev Match** (All, Match, or Cross-Rev) to control whether inventory at a different revision counts toward readiness. For the metrics and columns, see [Build readiness mBOM reference](/automate-with-ion/analytics-and-dashboards/build-readiness-mbom). ## aBOM Tracks installation progress and cost on as-built assemblies. Filter by **Part Number**, **Rev**, and **Serial**, and toggle **Hide root nodes** to drop top-level rows from the tree. For the metrics and columns, see [Build readiness aBOM reference](/automate-with-ion/analytics-and-dashboards/build-readiness-abom). An **Issues** view within this sub-tab lists only the parts with issues. ## Plans Measures fulfillment per plan. Pick a plan from the **Plan** selector or view all plans at once. For the metrics and columns, see [Build readiness plans reference](/automate-with-ion/analytics-and-dashboards/build-readiness-plans). # Overview Source: https://docs.firstresonance.io/automate-with-ion/analytics/index ION's built-in Analytics area: five dashboard surfaces covering inventory, build readiness, purchasing, quality, and run execution. Analytics is ION's built-in dashboard area. It answers the highest-frequency operational questions, such as what stock is available, which assemblies are ready to build, which purchase order lines are past due, how old open issues are, and which runs are overdue, without leaving ION or setting up a BI tool. It differs from the [Data Connector](/automate-with-ion/analytics-and-dashboards/data-connector), which is a read-only SQL layer for building your own reports in an external BI tool; Analytics is the reporting ION ships with. You open it from **Analytics** in the left navigation. The page is organized into five tabs, one per surface: | Tab | What it covers | | - | - | | [**Inventory**](/automate-with-ion/analytics/inventory-analytics) | Stock on hand by status and location, transaction history, and expiring inventory. | | [**Build Readiness**](/automate-with-ion/analytics/build-readiness) | mBOM readiness and shortages, as-built (aBOM) installation progress, and plan fulfillment. | | [**Purchase Orders**](/automate-with-ion/analytics/purchase-order-analytics) | Open PO lines, past-due aging, supplier on-time performance, and receipts. | | [**Quality**](/automate-with-ion/analytics/quality-analytics) | Open issues, resolution time, age distribution, and dispositions. | | [**Run Execution**](/automate-with-ion/analytics/run-execution-analytics) | Active and overdue runs, completion progress, and labor. | Each detail table has an **Export** button that saves the underlying data as a file. **Refresh** in the page header re-queries every widget on the current tab. Dashboards show only the data your role can access. # Inventory analytics Source: https://docs.firstresonance.io/automate-with-ion/analytics/inventory-analytics Stock on hand by status and location, inventory transaction history, and expiring or expired inventory. In ION, go to **Analytics > Inventory**. The surface has three sub-tabs: **Inventory**, **Transaction History**, and **Expiring Inventory**. Use it to answer: how much stock is available, where is it, what moved and who moved it, and what expires soon. Each detail table has an **Export** control that exports the table, with its current filters applied, to CSV. ## Inventory The default sub-tab shows overall stock health. The **Inventory Detail** table groups inventory by part, with cascading filters for part number, revision, trace, location, and status. ## Transaction History A ledger of every inventory movement: what changed, where it went, and who did it. Filter by inventory ID, **From Location**, **To Location**, and a date range. ## Expiring Inventory A table of inventory with expiration dates, marked **Expired** or **Good**. Use it to pull expiring stock before it reaches the floor. # Purchase order analytics Source: https://docs.firstresonance.io/automate-with-ion/analytics/purchase-order-analytics Open PO lines, past-due aging, supplier on-time performance, and receipt volume over time. In ION, go to **Analytics > Purchase Orders**. The surface has two sub-tabs: **PO Lines** and **Receipts**. Use it to answer: what is on order, what is late, which suppliers deliver on time, and what arrived recently. Each detail table has an **Export** control that exports the table, with its current filters applied, to CSV. ## PO Lines The default sub-tab tracks the open order book: * **Supplier On-Time %**: on-time delivery rate for the ten suppliers with the most lines. * **Purchase Order Lines**: a detail table. Its **Need Date Age** column buckets each line as Past Due, Due in 2wk, Due in 1mo, 1mo+, or No Need Date. ## Receipts The receiving side of the pipeline, scoped to recent activity: * KPI cards: **Receipts (30d)**, **Quantity Received (30d)**, **Avg Lead Time (30d)** (PO creation to receipt, purchase receipts only), and **Non-Purchase (30d)** for receipts not tied to a purchase order. * **Receipts**: a detail table with columns including **Receipt Date**, **Type**, **ION PO #**, **Supplier**, **Part Number**, **Qty Received**, and **Received By**. # Quality analytics Source: https://docs.firstresonance.io/automate-with-ion/analytics/quality-analytics Open issue counts, resolution time, age distribution, and disposition breakdown across quality issues. In ION, go to **Analytics > Quality**. Use it to answer: how many issues are open, how long do they take to resolve, which ones are aging, and how they are being dispositioned. The dashboard shows: * KPI cards: **Open Issues**, **Avg Days to Resolve**, **Active Redlines** (issues with active redlines), and **Open Further Actions** (issues with open corrective actions). * **Quality Issues**: a detail table with columns including **Title**, **Status**, **Disposition**, **Assigned To**, **Days Open**, **Age Bucket**, **Redlines**, **Actions**, and **Location**. The **Quality Issues** table has an **Export** control that exports the table, with its current filters applied, to CSV. For the underlying issue lifecycle, dispositions, and approvals, see [Issues](/track-quality/issues). # Run execution analytics Source: https://docs.firstresonance.io/automate-with-ion/analytics/run-execution-analytics Active and overdue runs, completion progress, step counts, and labor hours per run. In ION, go to **Analytics > Run Execution**. Use it to answer: how many runs are active, which are overdue, how far along each run is, and how much labor runs consume. The dashboard shows: * KPI cards: **Active Runs**, **Avg Completion**, **Overdue Runs** (past due date and still open), and **Avg Labor** in hours per run. * **Run Execution Detail**: a table with columns including **Run ID**, **Procedure**, **Part Number**, **Serial**, **Status**, **Progress**, **Steps** (completed out of total), **Failed** (failed step count), **Labor (hrs)**, **Assigned To**, and **Due Date**. The **Run Execution Detail** table has an **Export** control that exports the table, with its current filters applied, to CSV. For how runs and steps work on the floor, see [Runs and execution](/build-hardware/runs-and-execution). # Integrations Source: https://docs.firstresonance.io/automate-with-ion/integrations Third-party integrations and ION automations, prebuilt or build your own. An integration is a script that runs when something happens in ION. An ION event triggers it, usually through a [webhook](/api/guides/webhooks) and sometimes on a schedule. From there it can do almost anything: read and write ION data through the [GraphQL API](/api), call an external system, send a notification, or generate a document. First Resonance builds and ships prebuilt integrations through the [ION Marketplace](https://marketplace.firstresonance.io/), and you can also build your own. Integrations take many shapes. Two common ones: * A **third-party integration** syncs data between ION and another system, such as pulling part releases from your PLM or pushing purchase orders to your ERP. * An **ION automation** runs logic against ION itself, such as querying and mutating data through the GraphQL API when an event fires. ## Getting started * **Deploy a prebuilt integration or automation**: browse the [ION Marketplace](https://marketplace.firstresonance.io/), [Third-party integrations](/automate-with-ion/integrations/third-party-integrations), and [ION automations](/automate-with-ion/integrations/automations), then follow [Deploy an integration or automation](/automate-with-ion/integrations/deploying-integrations-and-automations). * **Build your own**: if nothing prebuilt fits, use the Workflow Builder, webhooks, or the GraphQL API. See [Create an integration](/automate-with-ion/integrations/create-an-integration). * **Design the data flow across systems**: see the [ERP and PLM reference architecture](/automate-with-ion/integrations/erp-plm-reference-architecture). * **Generate PDFs from ION objects** such as purchase orders and run packets: see [Export data as PDF](/automate-with-ion/integrations/export-data-as-pdf). ## Third-party integrations Connectors First Resonance and its partners maintain for the systems you already run, such as PLM, ERP, procurement, and collaboration tools. See [Third-party integrations](/automate-with-ion/integrations/third-party-integrations) for the full list. ## ION automations Prebuilt automations First Resonance maintains that run logic against ION itself. See [ION automations](/automate-with-ion/integrations/automations) for the current list and how they differ from ION Actions. # Arena Source: https://docs.firstresonance.io/automate-with-ion/integrations/arena Arena PLM Integration > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/arena.md`. Establish Arena as the source of truth for product/component metadata, and bill of materials (BOM), while ION parts remain up to date with changes made in Arena with no manual intervention. [https://www.loom.com/embed/1fe6a3a269714e1b865f2bacd52aa6a7](https://www.loom.com/embed/1fe6a3a269714e1b865f2bacd52aa6a7) ## Arena Change Order Submission Upon submitting a change within Arena, an event will be created to be processed by the integration. On the interval you set, the integration uploads the parts and associated attributes into ION. If applicable, for each top-level part the integration automatically generates a new draft mBOM version for that part, adds all of the components, and then releases that mBOM version in ION. ## Integration Set up 1. In the sidebar, select **Integrations**. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-128.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d0929c364f7866a75861ff7d625d5a21)The Integrations page 2. Select the Arena integration instance from the marketplace, and hit **Configure.** 3. Hit **Next** and add your API credentials. You can find documentation on [API keys](/api/authentication/api-keys) here. * **IMPORTANT:** Each API Key is associated with a specific environment, be sure to generate the API keys from the correct environment and configure the automation to the designated environment.\ ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-153.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=0224b7c62a6e46b5d733aeb5bdfb226d)Set your Environment According to Where the API Keys were Generated 4. Configure the Arena PLM Connection using your Arena login credentials as seen below: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2023-12-20-at-12-11-00-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=99ce0160f8765cc9fa3a5f7455dd35c6) 5. A note on revision schemes: If you have parts in arena with complex revisions (AA1, A1-N, etc...) you MUST ensure that a revision scheme matching that revision is present in your ION environment. For example, revision A01 has the format seen below. All that matters is that the format matches the revision. The integration will break if it cannot find a revision scheme that matches the revision attempting to be pushed.' ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-05-20-at-2-13-15-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=ec298259fcec0a56b4d5c573ad662260) 6. You have the option to drive the Sourcing Strategy in ION in two different ways. 1. The first is via a simple single-select custom attribute in Arena, as shown below. Make sure this attribute is added to the part category in Arena. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-431.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d41a86bf028ffa16332011f37e0c6931) To configure your integration to utilize this attribute, toggle the below configuration on and add this information to the Native attributes. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-432.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=79261aa2e4bcf8e1a76c20933d2ca037) ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-433.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=052aad6b68b12d62bf5e45ca1716a3f6) 2. Alternatively, you can use the sourcing relationships shown in [Sourcing information](#sourcing-information). > [!WARNING] > > Do not include tracking type information in the above native attributes data map. That is covered more in [Traceability attribute](#traceability-attribute). 1. To finish the configuration, you can map the data between the two platforms by adding key-value pairs for ION native attributes and custom attributes. The keys are ION fields and the values are Arena fields. Here is an example of what your custom attributes could look like. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-05-23-at-9-37-10-am.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d95bec3203e7324cc95276e2556e228f) ### Arena Specific Setup: #### Sourcing Information: When setting up your items in Arena you will have the option to set up sourcing relationships under the "Sourcing" tab. In the picture below I set up a sourcing relationship and a corresponding vendor part number. If you set this up, ION will be able to mark the part as MAKE/BUY/DUAL_SOURCE, will set the supplier part number, and will be able to pull over vendor into a custom attribute if you so wish. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-05-23-at-9-39-30-am.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=515228f61c2dfd91d61cd36ede9e7588) #### Thumbnails: You can bring over one image from Arena to set as the thumbnail for your ION part. In the files section of your item, you can add one file of the Image/Picture type. Here is an example: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-05-23-at-9-43-50-am.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=fc58323d61a7e824faeb61ce380d92bb) ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-434.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=33d4b56d84c6d81e33655cc8ed2e9c02) #### Traceability Attribute: To get the traceability information (LOT/SERIAL/NONE) to come over you will need to set up a custom attribute on the Arena side as shown in your workspace settings: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-05-23-at-9-48-26-am.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=c4ea489ec4fa73fcd4b5b8fdfe528378) ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-image-6.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=3d1ec3d860435d912f88d09023043ffe)Populate the the attribute name in this section of the Integration setup #### Non-planned items: It is common in manufacturing to design assemblies that will be sourced completely from a supplier. The supplier will source all of the sub-components of that assembly and deliver a completed assembly to your door. A common example of this type of sourcing is PCBAs. In these cases, it is common to only migrate the top-level assembly to ION instead of all the subcomponents (board-level components: capacitors, transistors, etc...). If migrated, the subcomponents can add unnecessary demand to ION's Autoplan MRP engine and cause as-built records for the assemblies to show incomplete. For these reasons, we built an additional (optional) feature in the integration that will only migrate the top-level assembly if it is marked on the item level in Arena. Here is the logic and setup: Below is a screenshot of an item-level attribute called "planned-item" (although you can call it anything you want). The mandatory part of this setup is the list values section. Make sure to have only two options "TRUE" & "FALSE" (case sensitive). If the attribute is set to FALSE on the item record then the integration will not migrate the BOM for that item. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-06-10-at-2-54-27-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=f2c18a69cd240ffaca9942e5b7f98cd6) #### Integration Configuration: To configure the integration's arena side, you need to create a trigger and an integration. To do this, you must have **admin privileges** #### Creating the trigger ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2023-12-20-at-12-20-23-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=b6ce26af6665801c8e462948154fa65b)**Navigate to workspace settings** ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2023-12-20-at-12-22-34-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=ebab137109ce11f58d7402d6a02b72a7)**Under the integrations tab, click the plus sign next to "Triggers" to add a new trigger** Press create new trigger and then add the following attributes: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2023-12-20-at-12-27-57-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=3d095e24c61556f7fae0a354d1a953e2) #### Creating the integration: You will need to create the integration via Arena, using the instructions documented [here](https://www.arenasolutions.com/solutions/marketplace/arena-ion-integration/). We recommend you acquire a machine integration user (cost \~\$3k) and set up the integration with those user credentials. Talk to your Arena rep or use the "Contact Support" button above to acquire a machine account. ### Finalizing the integration setup: After configuring the integration in Arena, you will need to get the integration GUID and paste that into the integration configuration in ION. Here is how you locate the integration GUID in Arena: 1. once you log in, you should see the integration in your main dashboard view ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-06-10-at-2-35-44-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=7b049a7b0b665db4de41bd31e65b7014) 2. Click the view (or reconcile) button on the right-hand side of the integration. 3. Once there, you should see this screen. The integration GUID is the capitalized string of characters after the colon. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/arena-screenshot-2024-06-10-at-2-42-19-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d1168b2682b88fb9b3c65cbbe3199dd5) 4. With that string in hand, you can navigate back over to the integration config in ION and enter that in the box at the bottom that says "integration GUID" ### Configuration Help: If you would like assistance setting up this integration or any other integration please reach out through Chat. # ION automations Source: https://docs.firstresonance.io/automate-with-ion/integrations/automations The prebuilt ION automations available in the Marketplace, and what each one does. An ION automation is a prebuilt integration that First Resonance maintains and runs logic against ION when an event fires. It can write back to ION, send notifications, generate documents, or call an external system. Deploy one from the Marketplace; see [Deploy an integration or automation](/automate-with-ion/integrations/deploying-integrations-and-automations). You can browse this same list in ION itself: in the sidebar, select **Integrations**. > [!NOTE] > > Both ION automations and [ION Actions](/automate-with-ion/ion-actions) run custom logic on an ION event, but they work differently. An ION Action runs inside ION while a change is being saved, so it can allow, block, or warn on that change. An ION automation runs on the integration platform and reacts to an event that has already happened, so it can't allow, block, or warn on a change. Instead it takes action, such as firing mutations, sending notifications, or calling external systems. Some of these automations are also available as a [Workflow Builder template](/automate-with-ion/workflow-builder/templates): a version you add to your own Workflow Builder and customize yourself, instead of one First Resonance runs for you. The **Template available** column notes which ones. | Automation | Description | Template available | | - | - | - | | Auto-approve part-procedure relationships | Approves a part-procedure link automatically and fills in its optional or required field. | Yes | | Auto-assign issue on creation | Assigns a new issue to the part's responsible engineer, the run's creator, or a configured team, in order. | Yes | | Auto-assign PO to the creator of the PO | Assigns the purchase order's creator as its assignee when the PO is created. | Yes | | Auto-checkout on inactivity | Checks a user out of their run session after a period of inactivity. | Yes | | Auto-consumption of line-side inventory | Deducts line-side inventory against the run's mBOM when a configured run step completes. | No | | Auto-create linear step dependencies | Adds a dependency from a newly inserted step to the steps immediately before and after it. | Yes | | Auto-kit expired material | Kits inventory nearing its expiration date on a schedule and assigns the kit to a team. | Yes | | Auto-populate quality clauses based on purchase order tier | Sets a PO's quality clauses from a configured tier attribute value. | Yes | | Auto-send purchase emails to suppliers | Emails a purchase order PDF to its supplier when triggered from ION. | No | | Auto-update mBOM revision on part revision update | Bumps the mBOM revision, and any draft mBOMs, when a part is revised. | Yes | | Auto-update part library cost based on purchase order line cost | Updates a part's library unit cost from its PO line cost once the order is placed. | Yes | | Autogenerate child issue for remove and replace dispositions | Creates a linked child issue for the removed part when an issue's disposition needs one. | Yes | | Autoplan scheduler | Runs Autoplan on a configured schedule instead of only on demand. | Yes | | Complete informational steps | Autocompletes an informational step, and its parent, once you've completed it once before. | No | | Data imprint | Copies a value between related ION records, such as part pedigree onto inventory. | Yes | | Data imprint from run step field to part inventory attribute | Copies a run step field's value onto the run's part inventory attribute. | Yes | | Imprint vendor name to part inventory | Copies the supplier name, or your org name for made parts, onto new part inventory. | Yes | | Intent data imprint | Copies intent-level data from runs and purchase orders onto part inventory, and applies upgrade or downgrade dispositions. | No | | ION Actions to control PO approval workflow | Deploys ION Action rules that enforce PO approval requirements, such as reviewer changes and cost-threshold approvals. | No | | Maintain only one procedure version | Archives a procedure's older versions when a new version is approved. | Yes | | Map inspection procedures by intent level | Creates an inspection procedure for a received part based on its PO line's intent level. | Yes | | Map inspection procedures by quality clauses | Creates an inspection run for a received part based on the quality clauses on its PO line. | Yes | | Migrate PO attribute data | Moves a value from one PO attribute to another, converting a number to text. | No | | Notify purchase order assignee of PO approval | Notifies the PO assignee, or its creator if none is set, when an approval is approved or rejected. | Yes | | Part inventory intent management | Blocks installing lower-intent inventory into a higher-intent part or kit. | No | | PO header to PO line attribute propagation | Copies purchase order attributes onto its lines, including mapped Need By and ETA dates. | No | | PO status control | Deploys ION Action rules that block a PO from skipping approval or entering review before every line has a cost. | No | | Prevent run closure if aBOM is not completed | Blocks a run's last step from completing or canceling until the aBOM is fully filled out. | No | | Purchase order PDF and versions | Versions a purchase order and generates a PDF as it changes through approval. | No | | Receiving data input requirements | Requires a receiving location, blocks over-receipt, or requires a serial or lot number, per your configuration. | No | | Recreate run on failure | Creates a replacement run when another run fails, so you can schedule the rework. | Yes | | Replace team assignee with specific role | Reassigns an issue from a team to a specific role on that team, such as the on-call person. | Yes | | Require part inventory details on run creation | Blocks run creation without a part inventory item, or without a lot or serial number, per your configuration. | No | | Run scheduler | Duplicates a run on a fixed schedule for work that repeats predictably. | Yes | | Scrap inventory on scrap disposition | Sets an issue's inventory to Scrapped when the issue resolves with a scrap disposition. | No | | Set close-by on issue creation | Sets the run step an issue must resolve by, so the run can't close while it's open. | Yes | | Set kitting status to draft | Sets a kit created from a run to Draft instead of Requested, so you can finish it before requesting. | No | | Update tool date of last maintenance | Sets a tool's last-maintained date when its maintenance run completes. | Yes | | Upload PO PDF to PO | Generates a PDF and attaches it to the purchase order once it's ordered. | No | # Create an integration Source: https://docs.firstresonance.io/automate-with-ion/integrations/create-an-integration Build your own integration when no prebuilt connector fits, using the Workflow Builder, webhooks, or the GraphQL API. When no [prebuilt connector or automation](/automate-with-ion/integrations) fits, you can build your own. Three patterns work well, from least to most code. ## Workflow Builder Build an integration visually in ION, without code. Use it to connect a system that isn't on the prebuilt list, or to assemble a custom automation from triggers and actions. See [Workflow Builder overview](/automate-with-ion/workflow-builder) for what you can build, or go straight to [Create a flow](/automate-with-ion/workflow-builder/create-a-flow) to wire up a flow's trigger and connection. The Workflow Builder is available to selected organizations. Contact [support.firstresonance.io](https://support.firstresonance.io) to enable it. ## Webhooks Push ION events to your own system as they happen. Subscribe to the resources and actions you care about, and ION delivers an event to your endpoint when they occur. Use this when your system reacts to changes in ION. See [Webhooks](/api/guides/webhooks). ## GraphQL API Read from or write to ION directly. The same GraphQL surface that powers the ION interface is available to you, so anything the app can do, your integration can do. Use this for two-way sync, bulk operations, or anything the Workflow Builder and webhooks don't cover. New to the API? Start with [Getting started](/api/getting-started). To take an API integration from your first call to production, see [Build a production integration](/api/guides/build-a-production-integration). For the full surface, see [the API reference](/api). > [!TIP] > > Pick one source of truth per concept (parts in PLM, inventory in ION, the general ledger in ERP) and sync one way from there rather than bidirectionally syncing every field. # Datum Source: https://docs.firstresonance.io/automate-with-ion/integrations/datum Connect ION purchasing with Datum sourcing so approved quotes create draft purchase orders in ION. > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/datum.md`. ### Integration Information From a high level, ION is your source of truth for inventory, and to get inventory into the system you need to receive purchase orders. Datum handles all functions related to the sourcing process including requisitions, managing and interacting with suppliers, quoting, approvals, and open-order updates. ION remains the source of truth for parts but the integration enables those parts to sync to Datum on release. Once the sourcing process is complete and the quote is approved in Datum, the integration creates a draft purchase order in ION. From there you can either issue the purchase order through the Datum supplier portal or continue to submit purchase orders using ION. See [ION automations](/automate-with-ion/integrations/automations) to email purchase orders to suppliers automatically. After the PO is submitted, expected delivery dates can be updated in Datum which will automatically update the line item ETA on the ION purchase order. Post-receipt functions like billing will still be handled by your financial management software. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/datum-screenshot-2024-02-16-at-2-23-09-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=2c671d6c5ca603bcabac0cd135f20b03)Here is a quick graphic depicting the standard purchasing flow overlayed with how the two tools connect. ### Integration Setup 1. In ION, in the sidebar, select **Integrations**. 2. Search for and select the Datum integration and then press **Configure** 3. Add your ION API keys which can be obtained by following the [API keys](/api/authentication/api-keys) documentation. Make sure to get API keys for the environment you are setting this integration up in. For example, if you are setting this up in sandbox you will need execute the API key instructions in sandbox. 4. Add your Datum API key which can be obtained in your Datum admin account page > Developer Tab 5. Please reach out to Datum at [matt@datumsource.com](mailto:matt@datumsource.com) for the rest of the Datum side of the integration setup. 6. Select UAT or Production to determine which Datum environment you will receive data from. 7. Press finish. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/datum-screenshot-2024-02-16-at-2-56-46-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=a05df98986b5ca9dbe7e9d1b91c507fc) # Deploy an integration or automation Source: https://docs.firstresonance.io/automate-with-ion/integrations/deploying-integrations-and-automations Deploy a prebuilt integration or automation from the ION Marketplace by configuring its ION API connection and the fields it needs. ION's prebuilt integrations and automations live in the ION Marketplace. To deploy one, open the Marketplace, configure its connection to ION, and fill in the fields the integration needs. ## Deploy from the Marketplace 1. In ION, go to **Developer Platform > Integrations** to open the ION Marketplace. 2. Find the integration or automation you want, then select **Configure**. 3. In the ION API connection step, enter your ION API key and secret, then select the environment to run in. See [API keys](/api/authentication/api-keys) for how to create them. 4. Fill in any additional fields the integration requires. These point the integration at the ION objects or attributes it acts on, and come as free-text inputs or pick-lists. Each integration documents its own fields. 5. For a partner integration, connect the external system (such as Arena, Duro, or Smartsheet) using that partner's setup steps. > [!WARNING] > > API keys are environment-specific. A sandbox key and secret do not work in production. Use keys generated in the same environment you are deploying to. > [!NOTE] > > An API key inherits the permissions of its creator. Create the key as a user with the permissions the integration needs. The integration's [webhook](/api/guides/webhooks) subscriptions are created when you first deploy an instance, and are removed only when you deactivate that instance, not when you pause it. > [!NOTE] > > Some webhook-driven automations need their trigger set explicitly: a **ResourceEnum** value (what to listen to) and a **WebhookSubscriptionActions** value (what to listen for). Find the valid values in ION's GraphQL documentation explorer, and match the input format exactly as it appears there. ## Troubleshooting > [accordion] You don't see the Integrations page > > Your organization might not have Marketplace access yet. Contact [support](https://support.firstresonance.io) to request it. > [accordion] ION integrations could not be loaded > > **Cause:** the page opened but the Marketplace could not authenticate. The most common reason is that your organization has no ION integrations configured yet. > > **Fix:** refresh the page. If the message comes back, contact [support](https://support.firstresonance.io) to have integrations enabled for your organization. > [accordion] An automation stops triggering after an environment change > > Each environment needs its own API keys, so an instance moved between sandbox and production stops working. Redeploy it with keys from the target environment: > > 1. Record the current setup of your instances. > 2. Deactivate the existing instances to clear any stray webhook subscriptions between environments. > 3. Create new instances using the API key and secret for the correct environment. > 4. Confirm the trigger's resource and action when you create each instance. > [accordion] A deployed integration shows no executions, and webhook events return 401 > > **Cause:** ION API credentials were stored on the integration's webhook trigger instead of on its ION API connection. ION delivers each event, the integration rejects it, and no execution is recorded. > > **Fix:** enter your API key and secret only in the ION API connection step. The ION Marketplace hides a flow's webhook trigger details, so a credential already stored there can't be cleared from ION. Contact [support](https://support.firstresonance.io) to have it removed. # Duro Source: https://docs.firstresonance.io/automate-with-ion/integrations/duro Duro PLM Integration > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/duro.md`. Establish Duro as the source of truth for product/component metadata, and bill of materials (BOM), while ION parts remain up to date with changes made in Duro with no manual intervention. [https://www.loom.com/embed/3d3d6732c5f648688179e797aa7c7621](https://www.loom.com/embed/3d3d6732c5f648688179e797aa7c7621) ### Duro Change Order Approved On change order approval within Duro, an integration with ION will fire which propagates part information and BOM changes to ION. Any time a new part, a new revision, or a new BOM is released in Duro via the change order process, that information will propagate to ION. ION, with the use of [mBOM versions](/build-hardware/bills-of-materials/versions), automatically generates a new draft mBOM version for that part, adds all of the components, and then releases that mBOM version in ION. > [!NOTE] > > Remember, ION does not have a release process and we do not prevent you from manipulating part data in ION once a component has been released in Duro. This is useful for setting sourcing strategy, tracking type, and supplier part relationships in ION if it is not set in Duro. If you want to prevent this, see [role-based access control](/administration/users-and-permissions). ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/duro-image-410.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=48fbbe4168812b7551de9b71c6ef2d45)Duro Integration ## mBOMs Versions in ION We recommend that you create a new mBOM version that you release in ION if you want to add additional information such as tape, epoxies, and adhesives not covered by the engineering BOM. ## Determining the Suppliers of your BOM When importing your BOM, we recommend you use [supplier part numbers](/manage-supply-chain/purchasing/unit-of-measure-conversions) to map the BOM to specific suppliers. This data feeds supplier and procedure suggestions, and often your procurement team lives in ION, so we do not recommend setting up the integration to pull this data from Duro and instead create that data directly in ION. We recommend creating a DCO to release a BOM into ION before it gets approved via an ECO, so you can parallelize sourcing and finalizing the engineering instead of treating this as a waterfall approach. The sole caveat is that you may want manufacturers and MPNs to come over to ION because engineering often is pulling those parts from a specific spec and manufacturer, especially for commercially available parts. From there, the sourcing team can use ION to determine the supplier/distributor for those parts. ## Set up 1. In the sidebar, select **Integrations**. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/duro-image-128.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=c431913915576d878c8a6aa84e7c1d88)The Integrations page 2. Select Duro integration instance from the marketplace, and hit **Configure.** 3. Hit **Next** and add your API credentials. You can find documentation on [API keys](/api/authentication/api-keys) here. * **IMPORTANT:** Each API Key is associated with a specific environment, be sure to generate the API keys from the correct environment and configure the automation to the designated environment. Be sure to also select the correct environment. If you are on the `Gov Cloud` environment then selecting `Production` will result in an error. Contact your Customer Success Engineer if you are unsure which environment you are on. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/duro-image-153.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=c4ab448c995929df62caf67f5371b05a)Set your Environment According to Where the API Keys were Generated 4. Generate a Duro API Key by [navigating to the integration settings page](https://mfg.duro.app/settings/integrations) and select Get API Key. Input that into the configuration of the integration. 1. NOTE: Duro API keys expire every 90 days. Learn more from [Duro here!](https://duro.zendesk.com/hc/en-us/articles/11814592464532-Quick-Start-Guide-to-using-Duro-s-GraphQL-API#h_01GMY1Z7ZGR8Y7KR4V8FG24F2M) 5. Select the Duro GraphQL Link. There are two possible values. ITAR clients should use `https://app.goveduro.us/graphql` while all others should use `https://mfg-core-api.duro.app/graphql`\ ![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXfBnf-0MscO26raOoqxfAfSWICDIYyuDx_byErykp_ztPN6PRIRYoS5HqvGq7Qx1j2lhQR6gYdS7nMDRoajWqIAHP2S9sVKgoDxRYPifIaiDlQEPDbEZqqd7NlkEOzDnzcQtUlRwQ?key=3JxpSXR3-j16s8dw8VV6B06V)Select the Duro GraphQL Link 6. Ensure the revision schemes for your production and prototype parts are created in ION and the names inputted into the configuration screen. Ensure the allow overflow box is checked if you are going to go over two characters.\ ![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXdsxlPQxJThK_8kcZX7RFCdp_osLoq-bAujwreACb0x94o7o7yWES8RhTMmSZENLgskEvJQLc-sYYa05d2YyYj_XrY6BFVMmxcJOo4vh2ADpOiJqU_4-_W4cmOaF0LcEMZW0xOUfQ?key=3JxpSXR3-j16s8dw8VV6B06V) 7. To finish the configuration, you can map the data between the two platforms by adding key value pairs for ION native attributes and custom attributes. The keys are ION fields and the values are Duro fields. Below is an example of the mapping. 1\. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/duro-image-495.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=e91bba46f214a1aa70f4287c8756599f) 8. You can map values from the primary source as well such as manufacturer or distributor, however, please see the above section on Suppliers in ION for our recommended approach. 9. Hit Finish to complete the integration configuration. Head to the *Test* page, and copy the Post URL of Flow 1 by clicking the *clipboard icon* as seen below in order to configure the webhook in Duro in the following step. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/duro-image-411.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=7185145fb6f3d2bb3d2b46a9cc93d69d)Find the Post URL of Flow 1 from the Test Tab 10. The last step is creating a Duro webhook that sends data to ION when a change order is approved. Navigate to the webhook page in settings and create new one. You can populate the URL with the URL you captured in the previous step. Fill out the remaining details as seen below. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/duro-image-150.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=34502f8b66477af6e5e9b609bffa54b5) > [!NOTE] > > Please ensure the *Include all Components and Products data* below is checked as seen below ### Current Limitations and Troubleshooting * At the moment, file attachments and links to specs, manufacturers, distributors, drawings, and others are not supported. * Ensure your revision schemas are updated in ION to support Alphabetical and Numerical and ensure the integration settings reflect the case-sensitive names. If you change the schema names in ION, ensure the integration is updated to reflect that. * Ensure you have selected the correct `Environment` and `Duro GraphQL Link` * If your Duro integration was working then suddenly stops, check your Duro API keys. The API keys from Duro are unique to each user and expire every 90 days! Learn more from [Duro here.](https://duro.zendesk.com/hc/en-us/articles/11814592464532-Quick-Start-Guide-to-using-Duro-s-GraphQL-API#h_01GMY1Z7ZGR8Y7KR4V8FG24F2M) # ERP and PLM reference architecture Source: https://docs.firstresonance.io/automate-with-ion/integrations/erp-plm-reference-architecture How ION integrates with ERP and PLM systems: the triad model, BOM lifecycle, canonical data flows, the 3-way match pattern, the 14 rules, and the recommended deployment sequence. ## Overview ION integrates with two adjacent system classes in every hardware-manufacturing stack: **PLM** (Product Lifecycle Management) upstream and **ERP** (Enterprise Resource Planning) downstream. This page is the reference for those integrations: what flows where, what doesn't, and the recommended deployment sequence. Read this before scoping an integration with [Arena](/automate-with-ion/integrations/arena), [NetSuite](/automate-with-ion/integrations/netsuite), [Teamcenter](/automate-with-ion/integrations/teamcenter), [Duro](/automate-with-ion/integrations/duro), Onshape, or any other ERP or PLM system. The per-vendor pages cover *how* a specific connector works; this page covers *why* the architecture is shaped the way it is. ## ION in the factory stack ION Factory OS is a **Manufacturing Execution System (MES)** at Level 3 of the ISA-95 enterprise-control hierarchy, with native production planning extending into Level 4. ION's job is to track and document the transformation of raw materials into finished goods on the production floor, and to be the closed-loop bridge between the engineering systems that *define* what gets built (PLM) and the financial systems that *transact* what gets bought, sold, and counted (ERP). ```mermaid theme={null} flowchart TB subgraph L4["Level 4: Business Planning & Logistics"] ERP["ERP
NetSuite · Dynamics 365 · SAP · Epicor"] PLM["PLM
Teamcenter · Arena · Windchill · Onshape · Duro · SolidWorks PDM"] CRM["CRM · HRM"] end subgraph L3["Level 3: Manufacturing Operations Management"] ION["ION Factory OS
MES + native production planning
Runs · Procedures · Quality · Labor · Traceability · As-built · Inventory (shop-floor)"] Adj["Adjacent L3 systems
LIMS · WMS · CMMS"] end subgraph L2["Level 2: Supervisory Control"] SCADA["SCADA · HMI · Historians"] end subgraph L1["Level 1: Direct Control"] PLC["PLC · DCS"] end subgraph L0["Level 0: Physical Process"] Field["Sensors · Actuators · Machines"] end L4 <-->|"Plans, intent,
transactions"| L3 L3 <-->|"Setpoints,
process data"| L2 L2 <--> L1 L1 <--> L0 ``` Every integration question reduces to *which level owns this data, and who else needs a copy?* The rules below fall out of this picture. ## Why integrate at all: the business goals Every ERP and PLM integration ION ships should trace back to one or more of these outcomes. If a proposed integration scope does not advance one of these, it is not the right scope. | Goal | What it means in practice | Where the integration lives | | - | - | - | | **Proper billing with 3-way match** | Vendor invoices are paid only when PO + Bill + Item Receipt match. No phantom payments, no missed receipts. | ERP ↔ ION | | **Inventory valuation** | Finance can value on-hand and WIP inventory in dollars, with audit trail back to receipts and consumption. | ION → ERP (receipts, completions, consumption) | | **Accurate COGS: material + labor** | Cost of goods sold is calculated from actual material consumed and actual labor recorded, not standard-cost approximations. Critical for cost-plus contracts and gross margin reporting. | ION → ERP (consumption + labor) | | **Reduce ERP seat license cost** | Production teams work in ION, not in NetSuite, Dynamics, or SAP. Only finance and procurement need ERP seats. | ION as the production UI; ERP for finance only | | **Engineering change traceability** | Production reflects the released engineering revision; as-built records tie back to the design version that produced them. | PLM ↔ ION | | **Closed-loop quality** | NCRs and deviations found in production feed back into engineering as ECRs; production runs don't proceed against stale revisions. | ION → PLM (NCRs / MRBs / inspection results) | Everything below is the architecture that makes them deliverable. ## The triad: PLM, MES (ION), ERP These three systems are the operational triad of any modern hardware manufacturer. Each owns a distinct part of the product's life. Trouble starts when one tries to do another's job. ```mermaid theme={null} flowchart LR subgraph PLM_block["PLM: Product Intent"] PLM["What the product
should be"] PLM_owns["Engineering BOM (eBOM)
Parts · Revisions · Drawings
ECN / ECR
Routings (engineering)
Product hierarchy"] end subgraph ION_block["ION: Production Reality"] ION["What the product
actually became"] ION_owns["Runs · Procedures
As-built BOM (aBOM)
Quality / NCRs / MRBs
Labor · Traceability
Shop-floor inventory
Issues · Deviations"] end subgraph ERP_block["ERP: Financial Transactions"] ERP["What the product
cost and earned"] ERP_owns["Suppliers (financial)
Purchase Orders
Item Receipts
Item master (financial)
GL · AP · AR · Costing"] end PLM -->|"Parts · eBOM · routings · ECNs"| ION ION -->|"As-built · NCRs · test results"| PLM ERP -->|"POs · suppliers · terms"| ION ION -->|"Receipts · completions · consumption"| ERP ``` **One-line summary:** * **PLM** = the *intent* (engineering definition). * **MES (ION)** = the *reality* (what actually happened on the floor). * **ERP** = the *accounting* (what was bought, what was received, what was paid). ## PLM ↔ ION reference architecture PLM is the system of record for the engineering definition of the product. ION is the system of record for what the production floor does with that definition. ### The BOM lifecycle: eBOM → mBOM → aBOM The BOM is not a single object. It evolves across the manufacturing lifecycle, and each stage has a different owner. Conflating them is the most common source of integration scope confusion. | Stage | Owner | What it is | Lifetime | | - | - | - | - | | **eBOM, Engineering BOM** | PLM | The design intent. The list of parts and assemblies the engineer specifies, by revision. Released into production. | Tied to the engineering revision; immutable once released. | | **[mBOM, Manufacturing BOM](/build-hardware/bills-of-materials/manufacturing-bom)** | ION | The manufacturing-ready BOM, derived from the eBOM. Adds manufacturing-only items (consumables, fasteners, fixtures), alternates, work-center assignments, kit groupings. | One per procedure version; updates with procedure revisions. | | **[aBOM, As-built BOM](/build-hardware/bills-of-materials/as-built-bom)** | ION | The actual record of what was consumed in a specific serial number or lot. Captures substitutions, scrap, rework, and deviations. | One per serial number or run; immutable once the run closes. | The flow is **eBOM (PLM) → mBOM (ION) → aBOM (ION) → optional feedback to PLM**. ```mermaid theme={null} flowchart LR eBOM["eBOM
Engineering BOM
(PLM)
Design intent"] mBOM["mBOM
Manufacturing BOM
(ION)
Released for production"] aBOM["aBOM
As-built BOM
(ION)
Actual consumption per SN"] Feedback["NCRs · MRBs ·
as-built reconciliation
(ION → PLM)"] eBOM -->|"Released revision"| mBOM mBOM -->|"Run instantiates
procedure"| aBOM aBOM -->|"Deviations,
configuration record"| Feedback Feedback -.->|"Drives ECRs"| eBOM ``` > [!NOTE] > > **When there is no PLM:** Many small or mid-stage manufacturers have no formal PLM. In that case, ION holds what is functionally an mBOM (sometimes informally called "the BOM"), and there is no upstream eBOM. This is acceptable for Phase 1 deployments. As soon as PLM is introduced (often Phase 3), eBOM authority moves to PLM, and ION's BOM becomes explicitly the mBOM. The "BOM lives in ION" state is transitional, not a permanent architectural commitment. ### Canonical data flows: PLM → ION | Object | Direction | Purpose | ION's role | | - | - | - | - | | **Items / Parts (engineering identity)** | PLM → ION | Establish the part the floor builds or consumes; carry engineering revision and lifecycle state. | Manufacturing reference; ION can also hold financial-side metadata that mirrors ERP's Items. | | **eBOM (engineering BOM)** | PLM → ION | Define what should be in the assembly per the engineering revision. | Source from which ION derives its mBOM. | | **Routings (engineering definition)** | PLM → ION | Define the high-level steps of manufacture. | Imported as procedure / step templates. | | **ECN / ECR notifications** | PLM → ION | Propagate engineering change. | Trigger procedure revision; surface to operators in-context; gate runs against stale revisions. | | **Drawings / CAD links** | PLM → ION (reference only) | Operator access to design spec. | Reference link in step content; ION does not host the CAD. | **On Items duplication:** Items typically exist in both PLM (engineering identity: revision, lifecycle, drawing reference) **and** ERP (financial identity: cost, GL account, tax code, vendor part number). PLM is the upstream source for the engineering attributes; ERP is the upstream source for the financial attributes. **ION holds the operational view**: the item as it appears on the floor, kitted, consumed, scanned. ION can pull from either or both depending on what's in the customer's stack. ### Canonical data flows: ION → PLM | Object | Direction | Purpose | PLM's role | | - | - | - | - | | **[As-built BOM (aBOM)](/build-hardware/bills-of-materials/as-built-bom)** | ION → PLM | What was actually consumed and built per serial number, with substitutions and lot/serial detail. | Engineering audit trail; configuration management; type certification record. | | **[NCRs / MRB outcomes](/track-quality/issues)** | ION → PLM | Defects, deviations, dispositions found in production. | Source for ECRs back into engineering. | | **In-process inspection / test results** | ION → PLM | Production verification data. | Engineering certification, type acceptance, design-of-experiments feedback. | | **Production traceability records** | ION → PLM (reference) | "This serial number was built from these parts via these procedures against this revision." | Linked to the design version that produced it. | ### What does NOT cross the PLM ↔ ION line * **eBOM authoring in ION.** PLM owns the engineering BOM when PLM exists. ION derives an mBOM from it; ION does not modify the eBOM. * **Drawings / CAD in ION.** ION holds reference links, not drawings. PLM is the source. * **Engineering revisions in ION.** Revision authority lives in PLM. ION shows the released revision in production context. * **Real-time CAD round-trip.** No live CAD editing from ION. If the operator finds a problem, that becomes an [NCR or MRB](/track-quality/issues), which feeds an ECR back to PLM, where the engineer makes the change. ### ION's PLM connector posture * **Production today:** [Arena](/automate-with-ion/integrations/arena) (multiple A\&D customers), Onshape (selected customers), [Duro](/automate-with-ion/integrations/duro) (in deployment). * **Partner-built:** [Teamcenter](/automate-with-ion/integrations/teamcenter) (via a PLM systems-integrator partner). Teamcenter integration sits at the PLM customization edge: most customers engage their PLM consultant for the Teamcenter side, and ION owns the ION side. * **Verify before scope:** PLM systems often have major version differences (Duro vs. Duro Hub, Windchill versions, on-prem vs. cloud Teamcenter). Verify the customer's actual deployment before signing scope. ## ERP ↔ ION reference architecture ERP is the system of record for financial transactions. ION is the system of record for production execution. They share a small, well-defined set of objects. ### Canonical data flows: ERP → ION | Object | Direction | Purpose | ION's role | | - | - | - | - | | [Purchase Orders](/manage-supply-chain/purchasing) | ERP → ION | Procurement → production trigger | Read-only execution view; lines mapped to ION parts | | Suppliers | ERP → ION (via PO) | Identify vendor on the floor | Created in ION as a side-effect of PO sync | | Payment Terms | ERP → ION | Reference data on POs | Display only | | Item master (financial) | ERP → ION (optional, lookup) | Item identity for non-PLM-driven shops | Read-only reference; PLM is preferred source if both exist | ### Canonical data flows: ION → ERP | Object | Direction | Purpose | ERP's role | | - | - | - | - | | [Receipts (shop-floor)](/manage-supply-chain/receiving) | ION → ERP | Materials physically received against PO | Triggers Item Receipt + financial posting | | Work order completions | ION → ERP | Production output recorded for cost rollup | GL recognition of completed inventory | | Labor / time | ION → ERP (cost-plus customers) | Direct labor on jobs | Cost-plus billing, GL labor allocation | | [Inventory](/manage-supply-chain/inventory) reconciliation | ION → ERP (report, not sync) | Periodic reconciliation between shop-floor reality and financial inventory | Adjusting entries; not real-time mirror | ### Syncing to ERP Prefer event-driven sync over scheduled polling. ION emits [webhooks](/api/guides/webhooks) the moment an event occurs, such as a run completing or a receipt posting, so the ERP stays current and failures surface in context instead of on the next poll. If your ERP doesn't need updates that often, have your integration queue ION's events and batch them into the ERP on a schedule. ION has supported integrations with NetSuite, Epicor, Dynamics 365, Business Central, Odoo, and Infor. To sync as-built consumption to the ERP, query the aBOM installations on the part inventory produced by completed runs: ```graphql theme={null} query ($filters: RunsInputFilters) { runs(filters: $filters) { edges { node { title partInventory { part { partNumber } quantity buildRequirements { abomInstallations { quantityInstalledPerParentPartInventory partInventory { location { id } part { partNumber } } } } } } } } } ``` For each installed part inventory, multiply the quantity produced by `quantityInstalledPerParentPartInventory` to get total consumption. The same component can appear more than once when it's installed from different inventory locations. For a run that produced three of Assembly Part One, that gives 15 of Component Part One (2.4 × 3 + 2.6 × 3) and 9 of Component Part Two (3 × 3). ### What does NOT cross the ERP ↔ ION line * **Bidirectional inventory sync.** ION owns shop-floor inventory in real time. ERP owns financial inventory at posting cadence. They reconcile periodically. *They do not bidirectionally mirror.* (See Rule 5 below.) * **Production scheduling in ERP.** Work order release and floor scheduling live in ION. ERP can hold high-level demand or master schedule, but the dispatch happens in MES. * **GL postings authored by ION.** ION emits the events (receipt, completion, labor). ERP posts to GL according to its own rules. * **Vendor bills, invoices, AP, AR.** ERP-only. Out of any normal ION integration scope. * **Items master authored by ION.** If PLM is in the picture, PLM authors. If ERP is the only product-data system (rare for hardware companies that build), ERP authors. ION never authors. ### ION's ERP connector posture * **Production today:** [NetSuite](/automate-with-ion/integrations/netsuite) (multiple deployments), Dynamics 365 (electric aviation customer). * **In-flight:** SAP (early scoping; pattern not yet certified). * **Customer-side configuration is the customer's responsibility:** custom forms, scripts, saved searches, OAuth, role permissions, sandbox provisioning. Either the customer's internal ERP admin or the customer's ERP consulting partner. ### The 3-way match: the canonical AP control loop The single most-asked-for outcome from any ERP integration is **3-way match**: the financial control that prevents an invoice from being paid unless three documents agree. ```mermaid theme={null} flowchart LR subgraph ION_side["ION (production)"] Run["Run / Receipt event
on the floor"] end subgraph ERP_side["ERP (3-way match)"] PO["Purchase Order
What was authorized"] Receipt_ERP["Item Receipt
What physically arrived"] Bill["Vendor Bill
What the vendor invoiced"] Match{"3-way
match"} Pay["AP releases
payment"] end Run -->|"Receipt in ION
creates Item Receipt"| Receipt_ERP PO --> Match Receipt_ERP --> Match Bill --> Match Match -->|"All three agree
(qty, price, item)"| Pay ``` **ION's role in 3-way match:** ION's job is to make the **Item Receipt** real, automatic, and accurate by recording what physically arrived at the receiving dock and triggering the matching ERP record. Without a connected ION, the Item Receipt is a manual data-entry step in the ERP that operators forget, mis-key, or batch up. This is where most "phantom payments" and "missed receipts" come from. **What 3-way match needs from each side:** | Side | Required | Why | | - | - | - | | ERP | Purchase Orders with line-level detail (item, qty, price); Vendor Bill workflow; Item Receipt entity that can be created via API. | The match logic lives in ERP. | | ION | Receipts at the line level, tied back to the originating PO via a durable join key; quantity and item agreement with the PO line. | The trigger event lives in ION. | | Customer process | Vendor invoices submitted to AP through a defined channel; receiving discipline at the dock (don't receive what didn't arrive). | The control only works if the human process feeds it. | ### Multi-location and inter-location transfers Customers with multiple physical sites introduce a class of integration questions that single-site customers do not face: * **Where does inter-location inventory transfer get recorded?** ION owns the operational transfer (parts physically move site-to-site under custody chain). ERP owns the financial reclassification (inventory by location for tax / GL). * **Granularity question:** does the ERP need site-level inventory tracking, or is location-level handled entirely in ION? Most customers benefit from site-level rollups in ERP and bin/cell-level granularity in ION. * **Planning question:** does demand at one site automatically trigger procurement at another, or are sites planned independently? This is a planning-system question more than a strict integration question, but it shapes how much of MRP / Autoplan to expose across sites. These are scoping questions for the Phase 2 / Phase 3 conversation. Surface them early when the customer has more than one site. ### PO setup attributes ERP POs typically carry attributes that ION needs but doesn't author: department, location, cost center, project code, GL account override, tax code. These need to flow with the PO so that ION can route receipts to the correct location and so that downstream financial events (consumption, completion) carry the right tags. The ION NetSuite connector handles this via configurable PO Header and PO Line attribute data maps. For non-NetSuite ERPs, equivalent mappings need to be defined per integration. **This is configuration, not code**, but it is non-trivial work that should not be skipped at scoping time. ## The combined picture: ION as the execution spine In a fully-instrumented A\&D or hardware manufacturer, the three systems form a closed loop. Each cycle of build → release → ship → invoice closes through ION. ### Integration control plane The triad above is the executive view. Use the diagram below for scoping: it groups objects by ownership, shows the high-confidence lanes, and keeps financial posting separate from operational execution. ```mermaid theme={null} flowchart LR %% Keep ownership explicit: PLM defines, ION executes, ERP accounts. classDef plm fill:#eef5ff,stroke:#6b9bd8,color:#1f2937 classDef ion fill:#eefcf6,stroke:#35a06e,color:#1f2937 classDef erp fill:#fff7e6,stroke:#d28b27,color:#1f2937 classDef event fill:#f5f3ff,stroke:#8b5cf6,color:#1f2937 classDef ledger fill:#fdf2f8,stroke:#db2777,color:#1f2937 subgraph PLM["PLM: engineering definition"] direction TB ENG_ITEMS["Engineering items
revisions · lifecycle"]:::plm EBOM["Released eBOM"]:::plm CHANGE["ECNs / ECRs"]:::event ENG_ITEMS --> EBOM --> CHANGE end subgraph ION["ION Factory OS: execution spine"] direction TB PARTS["Operational parts
shop-floor identity"]:::ion MBOM["mBOM + procedures
build plan"]:::ion DEMAND["Demand + plans
work order release"]:::ion RUN["Run execution
operators · quality · labor"]:::ion ABOM["aBOM + receipts
actual material record"]:::ion INV["Granular inventory
bin · cell · serial · lot"]:::ion PARTS --> MBOM --> DEMAND --> RUN --> ABOM --> INV end subgraph ERP["ERP: financial system of record"] direction TB FIN_ITEMS["Financial item master
cost · GL · tax"]:::erp PO["Purchase orders
suppliers · terms · attributes"]:::erp MATCH["3-way match
PO · receipt · vendor bill"]:::ledger LEDGER["GL · AP · AR
valuation · postings"]:::ledger FIN_ITEMS --> PO --> MATCH --> LEDGER end ENG_ITEMS -->|"engineering identity"| PARTS EBOM -->|"released structure"| MBOM CHANGE -->|"change impact"| MBOM CHANGE -->|"NCR / MRB feedback"| RUN PO -->|"PO sync + line attributes"| DEMAND PO -->|"supplier context"| PARTS FIN_ITEMS -.->|"optional financial lookup"| PARTS ABOM -->|"item receipt event"| MATCH ABOM -.->|"consumption posting"| LEDGER INV -.->|"valuation reconciliation
not bidirectional sync"| LEDGER RUN -.->|"as-built feedback"| CHANGE ``` **How to read this diagram:** * **Each column has one owner:** PLM owns engineering definition, ION owns execution truth, and ERP owns financial accounting. * **ION is the execution spine:** engineering releases and ERP demand converge into parts, mBOMs, plans, runs, aBOMs, receipts, and granular inventory. * **Financial controls stay clean:** ION creates real receipt and consumption events; ERP performs 3-way match, AP / AR, GL, and valuation. * **Dotted arrows are posting or reconciliation paths:** they update accounting or feedback systems without creating bidirectional inventory ownership. ### Reference deployments ION is in production across the following ERP and PLM combinations. New customers can scope against these patterns rather than starting from scratch. | Industry segment | ERP | PLM | Integration shape | Status | | - | - | - | - | - | | Satellite communications (mid-size) | NetSuite | Arena | PO sync NS→ION; Item Receipts ION→NS; Arena part / eBOM sync | Live | | Autonomous maritime (mid-size) | NetSuite | None | PO sync; inventory reconciliation reporting | Live | | Electric aviation (large) | Dynamics 365 | (mixed) | ERP sync; webhook-based event flow | Live | | Defense maritime (small, high-growth) | NetSuite | None | Phased: ION standalone → NS PO + receipt sync | In deployment | | Defense / aerospace tooling | NetSuite | Teamcenter | Three-system: NetSuite ERP + Teamcenter PLM + ION MES | Active scoping | | Defense engine components | (varies) | Arena | Quality + procedure sync | Active | ### The recommended sequence for a new customer The following deployment sequence is recommended. Each phase is useful on its own, so you can adopt them in order without waiting to finish the rest. ```mermaid theme={null} flowchart LR P1["Phase 1: Foundation
ION standalone
Runs · Procedures · Quality
Inventory (shop-floor)
Operator workflows
Traceability"] P2["Phase 2: Connect
ERP integration
POs · Receipts · Suppliers
(via certified connector)"] P3["Phase 3: Engineering loop
PLM integration
Parts · eBOM · ECNs · Routings
As-built feedback"] P4["Phase 4: Orchestrate
Forward-deployed scope:
ION-driven PO creation
(Autoplan)
Cost roll-ups
Outside processing"] P1 --> P2 P2 --> P3 P3 --> P4 ``` **Phase 1, Foundation.** ION is deployed standalone as the production system of record. [Procedures](/build-hardware/procedures), [runs](/build-hardware/runs-and-execution), [quality](/track-quality/issues), kitting, traceability, and [shop-floor inventory](/manage-supply-chain/inventory) live in ION. ERP and PLM continue to operate as today. **No integration dependency for go-live.** **Phase 2, Connect (ERP).** A pre-built, certified connector links ION to the ERP. [POs](/manage-supply-chain/purchasing) flow into ION, [receipts](/manage-supply-chain/receiving) flow back. The customer's ERP admin or consultant configures the ERP-side; ION's team configures the ION-side. **Configuration, not custom development.** **Phase 3, Engineering loop (PLM).** PLM integration brings part master, eBOM, and engineering change notifications into ION; sends as-built and NCR data back. Often phased: parts + eBOM first; ECNs and as-built second. **Phase 4, Orchestrate.** Forward-deployed engineering work that goes beyond the certified connectors: ION-driven PO creation via Autoplan, financial cost roll-ups, outside processing flows, cost-plus labor reporting. **Scoped per engagement, not assumed.** ## Canonical rules The following rules apply to every ION integration. They are the distillation of canonical MES/ERP/PLM literature (ISA-95, MESA) and the accumulated experience across 20+ customer deployments. They keep integration scope aligned with what works in practice. | # | Rule | Why | | - | - | - | | 1 | **PLM owns engineering intent. ION owns production reality. ERP owns financial transactions.** | The triad. Every other rule follows from this. | | 2 | **PLM authors the eBOM. ION produces the [as-built BOM](/build-hardware/bills-of-materials/as-built-bom).** They are different objects with different lifecycles. | The eBOM is design-time; the aBOM is run-time. Trying to merge them creates ambiguous state. | | 3 | **Engineering revisions are released *into* production, not authored *from* it.** Operator-found problems become NCRs/MRBs that feed ECRs back to PLM, where the engineer makes the change. | Configuration management requires a single authoring path. | | 4 | **POs are owned by ERP. Receipts on the floor are owned by ION.** A receipt in ION triggers an Item Receipt in ERP, not the reverse. | Production reality leads; financial recording follows. | | 5 | **Inventory does not bidirectionally sync between ION and ERP.** ION holds shop-floor reality in real time; ERP holds financial inventory at posting cadence. They reconcile, they do not mirror. | The single most damaging anti-pattern in MES/ERP integration. Bidirectional sync creates race conditions, conflicting truths, and reconciliation hell. | | 6 | **Inventory and locations are out of scope for any first-pass ERP integration.** Phase 3+ conversation, scoped explicitly. | Pulling inventory into a first-pass ERP sync creates more reconciliation pain than it solves. | | 7 | **Production scheduling lives in MES.** ERP can hold demand or master schedule; dispatch happens in ION. | Schedule rigidity in ERP is incompatible with shop-floor reality. | | 8 | **Items master lives where it was born.** PLM if engineering-led, ERP if procurement-led. ION never authors. If both PLM and ERP claim it, PLM wins for hardware companies. | Single source of truth for item identity. | | 9 | **Connectors before commitments.** ION integrations are available via pre-built, certified connectors. New connectors are scoped, priced, and sequenced separately, not assumed in a master agreement. | Avoids the "we'll build it" trap that produces multi-month delays and missed scope. | | 10 | **Every integration ships with a defined acceptance criterion, owner, and SLA.** No indefinite UAT states. | UAT-stuck-at-90% is the second-most-common failure pattern after scope ambiguity. | | 11 | **Health monitoring is part of the integration, not a follow-up.** Integrations that "worked at handoff" but degraded silently are unacceptable. | Post-launch silent degradation is how customers lose confidence in months, not weeks. | | 12 | **Verify the customer's actual environment before scoping.** ERP version, PLM version, on-prem vs. cloud, custom forms / scripts already in place. | Wrong-version assumptions cause weeks of delay. | | 13 | **Three-party engagements (ION + customer + customer's SI) require explicit scoping with all three named on the SOW.** | Scoping gaps between ION and the customer's SI cause silent failures and finger-pointing. | | 14 | **Default to two-party (ION + customer).** Insert third-party SI only when the customer's environment requires it (for example, PLM that needs vendor expertise like Teamcenter) or the customer asks for it. | Smaller engagement, fewer hand-offs, less cost. | ## Source documents * **ISA-95 standard**: ANSI/ISA-95.00.01 *Enterprise-Control System Integration* * **MESA model**: Manufacturing Enterprise Solutions Association, MESA-11 functional areas # Export data as PDF Source: https://docs.firstresonance.io/automate-with-ion/integrations/export-data-as-pdf How to export data from ION in the form of a PDF > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/pdf-generator.md`. This guide outlines a way to export data from ION using a tool we also use internally: [Carbone.io](https://carbone.io/). > [!NOTE] > > This method does not protect ITAR-restricted data. See [Carbone disclaimer](#carbone-disclaimer) below. *** ### Step 1: Start with an Example PDF Start with an example PDF you already use today, ideally one that includes all the data you want to share in the format your recipients expect. This could be a purchase order, audit log, or build report. *** ### Step 2: Define the Data Query Using the ION GraphQL Explorer, create the API query you need to retrieve all of the information that appears in your example PDF. Identify a real object in ION, such as a purchase order, run, or quality issue, as a sample to build and test your query against. Ensure the query returns data in a structured JSON format that matches the fields and structure expected by the template you will create in Step 3. Below is an example of a query and the response. API Call: ```graphql theme={null} { partKit(id:780){ _updated id deliveryLocation{ address } partKitItems{ part{ partNumber revision description } quantity } } } ``` JSON Response: ```json theme={null} { "data": { "partKit": { "_updated": "2025-05-08T00:33:40.275245", "id": 780, "deliveryLocation": { "address": "600 Wilshire Blvd,\nSuite 1500,\nLos Angeles, CA 90017" }, "partKitItems": [ { "part": { "partNumber": "7777-03", "revision": "C", "description": "Wheel assembly" }, "quantity": 4 }, { "part": { "partNumber": "1111-545-01", "revision": "B", "description": "Mounting screw" }, "quantity": 8 }, { "part": { "partNumber": "7777-02", "revision": "B", "description": "Car body" }, "quantity": 1 }, { "part": { "partNumber": "SA", "revision": "1", "description": "Spoiler Assembly" }, "quantity": 2 } ] } } } ``` *** ### Step 3: Create the Template and Test Use the example PDF from Step 1 as a guide to create a `.docx` or `.odt` template file. Your goal is to recreate the layout and structure of the PDF using Carbone's templating syntax. For each field in your JSON response from Step 2, insert a dynamic placeholder in the template to represent the data. For example, if you're working with a part kit, your template might include placeholders like `{data.partKit.id}`, or `{data.partKit.deliveryLocation.address}`. Below is an example of a template we created to generate a packing list. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/export-data-as-pdf-image-480.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=992ff82f2a2e468c55eaeff808070bc8) [Download file](/images/automate-with-ion/packing-list.docx) > [!NOTE] > > If you need more information on how to configure complex templates with Carbone.io, we recommend checking out their [quickstart guide!](https://carbone.io/documentation/quickstart/getting-started/generate-a-document.html) Once your template is ready, upload it to Carbone.io and pair it with the JSON data to generate the final PDF. You can preview and adjust formatting as needed until the output matches your expectations. > [!NOTE] > > We recommend adding a few dynamic placeholders at a time in order to test and quickly debug if needed. Each template created will have an ID and Carbone has an API key that you can use to automatically call it's API and generate these reports. Here is an example of the [Carbone.io studio](https://carbone.io/documentation/quickstart/getting-started/generate-a-document.html) which enables us to determine if the template is rendering the data correct. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/export-data-as-pdf-image-481.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d5b6a11732d6ff68b3ffeb3c907ab632) *** ### Conclusion You can use the template ID and Carbone API key to setup automated workflows that upload PDFs to ION based on an [event that is triggered](/api/guides/webhooks). ## Carbone disclaimer ION uses [Carbone](https://carbone.io/), a third-party open-source PDF generator, for PDF document creation via the API. Carbone is designed with privacy in mind: data is not stored and is used only for report generation. Reports are automatically deleted immediately after download, or within one hour, whichever comes first. If you need heightened data privacy, Carbone offers on-premise and AWS private cloud hosting options. See [Carbone on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-m4tdvrln53afm). Carbone is an independent project, not maintained by First Resonance. For support, updates, or security inquiries related to Carbone, refer to its open-source community. ION ensures integration compatibility but does not assume liability for Carbone’s functionality or security. # NetSuite Source: https://docs.firstresonance.io/automate-with-ion/integrations/netsuite How the paid NetSuite ERP integration connects ION purchasing, receiving, and inventory data with NetSuite accounting. > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/netsuite/README.md`. > [!NOTE] > > Please note that the Netsuite integration is available as a **paid add-on**. Contact your customer success manager to learn more about pricing and how to enable the Netsuite integration for your account. NetSuite is a cloud-based ERP. The integration between ION and NetSuite is not a one-size-fits-all solution; it requires careful configuration to align with specific business needs and the existing setup of NetSuite. ## Recommended System Configuration High-level goals of the integration: 1. Billing integration with proper 3-way matching functionality 2. AP/AR/GL tracking 3. Accurate cost of goods sold (COGS) for make parts (labor and materials) 4. Controlled sales order process When thinking about how your systems interact it is important to define a business process "swimlane." The swimlane should contain key business processes and in which system you desire them to be performed. Here is a common NetSuite ↔ ION business process swimlane: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-image-342.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=74e2d3c6c3fc97ba214168b53e30440b) In the above example, Business A wishes to do all their factory operations like purchasing, receiving, warehouse management, work order execution, etc... in ION and use NetSuite for sales, employee configuration, vendor onboarding, billing, etc... The two systems need to talk to one another to ensure the right data is available to perform said processes. Once you have a high-level idea of your business processes and where they will be performed it is helpful to understand how and where the systems will interact & the level of detail required to be pushed between systems. Here is an **example** NetSuite configuration diagram based on tried and true business practices & with the simplicity/reliability of the integration in mind: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-image-14.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=1b50daef039094e1111b5e456108eb99) In the above diagram, ION handles everything from plans to work order execution. Telling NetSuite when it makes purchase orders, consumes material on runs, and scraps material due to quality defects. An (optional) addition to the software stack is a PLM to manage engineering development and part release. The PLM sends parts to both systems, and BOMs to ION, so that activities can happen on the ION side and GL configuration can happen on the NetSuite side. A few additional notes: 1. Sales orders, created in NetSuite, transfer over to create Autoplan inputs 2. Purchase orders are generated from plans in ION. These purchase orders are duplicated on the NetSuite side to add inventory to the system and to enable billing 3. Receiving activities in ION to generate item receipts in NetSuite to enable a 3-way match 4. Billing activities can take place in NetSuite 5. Runs are generated from ION plan items using procedures. Runs can generate workOrder objects in NetSuite (optional) or upon run completion an assemblyBuild record can be generated to put assemblies into NetSuite at cost (labor and materials) 6. When material is scrapped in ION, the material is scrapped in NetSuite 7. Both systems have inventory but ION maintains the granular location-based tracking & NetSuite has a bucketed view. Doing so gives finance teams a simplified, yet accurate, view of inventory. Bucketizing the inventory in NetSuite also greatly simplifies the integration between the two systems. You can change this recommended flow to fit your business. #### Additional NetSuite ↔ ION Integration Workflows Three example configurations follow, from basic to complex. Other configurations are possible. **1. Basic Workflow (Foundational Integration)** * **ION** manages purchasing, receiving, and work order execution. * **NetSuite** manages vendors, billing, and general ledger. * Purchase Orders initiated in ION are mirrored in NetSuite for financial tracking. * Receiving in ION automatically creates Item Receipts in NetSuite to enable 3-way matching. * Inventory is tracked in detail within ION; NetSuite maintains simplified, bucketized balances. * Billing and invoicing occur exclusively in NetSuite. *Use case:* Ideal for early-stage teams needing reliable financial reporting and auditability while keeping factory operations simple. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-integration-diagrams-3.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=e9ddf3c935909a602b939b4a490630dc) **2. Medium Complexity Workflow (Operational & Financial Alignment)** * Sales Orders originate in NetSuite and flow into ION as demand signals for Autoplan. * **ION** executes planning, purchasing, receiving, and production runs. * Purchase Orders and Receipts in ION sync back to NetSuite to drive AP/AR and vendor performance tracking. * Work Orders in ION can generate corresponding Work Orders or Assembly Builds in NetSuite, enabling accurate COGS calculations. * Scrap, rework, and disposition data in ION syncs with NetSuite for visibility into material variances. * Finance teams rely on NetSuite dashboards for consolidated reporting, while operators use ION for granular traceability. *Use case:* Companies scaling production who need tighter operational and financial visibility while maintaining efficiency. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-integration-diagrams-1.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=229c7f600aa78135ac24267ee02dc1e8) **3. Complex Workflow (Full Lifecycle Integration)** * **PLM → ION + NetSuite:** PLM pushes part data and BOMs to ION and part master data to NetSuite. * **Sales Orders → Autoplan:** NetSuite sales orders drive Autoplan scheduling in ION. * **Procurement:** Purchase Orders are generated in ION, synced with NetSuite for vendor invoicing, and tracked bi-directionally. * **Receiving + Quality:** Receiving in ION creates receipts in NetSuite and optionally triggers quality workflows (inspection, NCRs). * **Production:** Runs in ION trigger Work Orders in NetSuite; on completion, ION passes assembly build data (materials + labor) to NetSuite for COGS and financial reconciliation. * **Inventory:** ION manages granular, location-level inventory while NetSuite holds consolidated inventory positions for finance. * **Disposition + Analytics:** Scrap, rework, and further actions in ION are synced to NetSuite for accurate reporting. *Use case:* Organizations in regulated industries (aerospace, defense, medical) requiring tight digital thread integration from engineering through production to finance. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-integration-diagrams-2.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d80b6238cf80178f173b7a9c3211398d) Notes on Customization * Customers often start with a **basic integration** and evolve toward **medium or complex workflows** as production volume and reporting requirements grow. # Purchasing in NetSuite, Receiving in ION Source: https://docs.firstresonance.io/automate-with-ion/integrations/netsuite/netsuite Sync purchase orders from NetSuite into ION and send ION receipts back for three-way matching. > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/netsuite/netsuite.md`. Sync purchase orders created, approved, or rejected in NetSuite with [ION Purchases](/manage-supply-chain/purchasing). NetSuite handles purchase order approvals, accounting, and finance. Once the purchase order is created in ION, receive the inventory from each purchase order and sync the receipts into NetSuite so you can 3 way match. ### Functionality * Purchases that do not yet exist in ION will be created and a custom attribute called "Netsuite PO Number" will store the NetSuite PO Number associated with the ION Purchase. These will not match so please use this value to compare NetSuite against ION. * Purchase order updates like line changes or header changes will be reflected on the ION side * Suppliers will be created in ION if they do not exist at the time of purchase * Parts need to be manually maintained in both systems for the ION purchase to be correctly populated. [Warning logs](/automate-with-ion/integrations/deploying-integrations-and-automations) will appear that let you know when parts or suppliers do not exist in ION. * Receiving: Upon saving a receipt in ion (pressing Save Receipt), an itemReceipt will be created in NetSuite for the purchase order linked to the receipt. * Upon closing a PO in NetSuite, open purchase order lines in ION will be canceled * Upon deleting a PO in NetSuite the PO will be deleted in ION #### Purchase Order Statuses | NetSuite Status | ION Status | | - | - | | Pending Supervisor Approval | Draft | | Approved by Supervisor Pending Receipt Partially Received | Ordered | | Pending Bill, Fully Billed | Received | | Closed | Canceled | ### Setup 1. Follow the initial setup on the [deploying integrations and automations](/automate-with-ion/integrations/deploying-integrations-and-automations) page to get started. 2. To authenticate with NetSuite, please follow these instructions as an administrator: 1. Enable SuiteTalk * Navigate to **Setup** > **Company** > **Enable Features** * Under the **Suite Cloud** tab, ensure that both **REST WEB SERVICES** and **OAUTH 2.0** are checked. 2. To Create an OAuth 2.0 app with JWT Option * Go to Setup > Integration > Manage Integrations > New * Give your integration a name and a description. * Un-check **TOKEN-BASED AUTHENTICATION** and **TBA: AUTHORIZATION FLOW** under Token-based Authentication * Ensure the following are checked under OAuth 2.0 * **REST WEB SERVICES** * **CLIENT CREDENTIALS (MACHINE TO MACHINE) GRANT** * Take note of and save your **CONSUMER KEY** and **CONSUMER SECRET** as it will not be shown again in Netsuite after this step 3. Generating the Certificate ID and Private Key for JWT * A private key is required for JWT-based authentication. Follow the steps below or refer to the [NetSuite Documentation](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_162686838198.html#Related-Topics) for generating or importing a private key. * On your machine create a valid certificate abiding by the Netsuite requirements using OpenSSL in a terminal. This will generate two .pem files on your local machine containing key used as the **Private Key for JWT** information and the certificate for the next step * Example query: `openssl req -x509 -newkey rsa:4096 -sha256 -keyout auth-key.pem -out auth-cert.pem -nodes -days 730` * .pem files generated: auth-key.pem, auth-cert.pem * In Netsuite, navigate to Setup > Integration > OAUTH 2.0 CLIENT (M2M) SETUP and select **Create New** * Choose the proper **Entity**, **Role**, and select the **Application** created in the previous section. * For **Certificate** choose the auth-cert.pem file generated in the previous steps. * Press save * Once saved, a **Certificate ID** is generated. Save this for the ION integration. 4. In your ION integration's connection configuration, select the **Netsuite OAuth 2.0 Client Credentials** connection type and enter the following: * Token URL: [https://\.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token](https://6340330-sb1.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token) * Certificate ID from OAUTH 2.0 CLIENT (M2M) SETUP * Private Key from the auth-key.pem file. copy the entire text including the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- text * Consumer Key (Client ID) from the Netsuite integration * Consumer Secret (Client Secret) from the Netsuite integration\ 3. For the integration to work successfully you need to create the following custom attributes in your organization settings: 1. purchase order -- key: "Netsuite PO Number", type: String 2. purchase order -- key: "Netsuite RecordID", type: String 3. purchase order line -- key: "Non-receivable", type: Boolean 4. purchase order line -- key: "ns_line_id", type: Number 4. Configure your custom attributes by mapping ION custom attribute name (left) to the attribute name in your Netsuite instance. Below is an **EXAMPLE** of what a mapping can look like. Please reach out to your Netsuite IT administrator or consultant to get a list of attributes to map. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-screenshot-2024-07-16-at-11-59-41-am.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=075ca1139fd97952281417a4ff25ba04) ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-screenshot-2024-07-16-at-11-59-12-am.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=65de0b2a9d898c6d20673b549ed7276b) 1. Hit **Finish** and take note of the URL for the Purchasing Flow\ ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-image-239.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=56e49b862b2b6538305886e1a91d40f6)Hit the clipboard icon to copy this URL. You will need this in the next step 2. Create a custom script by navigating to **Customization > Scripting.** Save the below script locally and use that when creating a new script. The script that will send updates to ION when Purchase Orders in NetSuite are updated and created. Update the URL in the HTTPS POST method to the URL you copied from above. 1. WARNING: When you upload the script, ensure that your script name has .js after it or you will get a 'MODULE NOT FOUND' error when saving a purchase order. ````javascript theme={null} /** * @NApiVersion 2.x * @NScriptType UserEventScript * @NModuleScope SameAccount */ define(['N/https', 'N/record', 'N/log'], function(https, record, log) { function afterSubmit(context) { var newRecord = context.newRecord; var purchaseOrderId = newRecord.id; var eventType = context.type; var poData = { POId: purchaseOrderId, eventType: eventType // 'create', 'edit', or 'delete' }; if (eventType === 'delete') { // Handle deletion poData.message = "Delete this purchase order in ION"; } else { // Handle create or edit var poRecord = record.load({ type: record.Type.PURCHASE_ORDER, id: purchaseOrderId, isDynamic: true }); poData.tranId = poRecord.getValue({ fieldId: 'tranid' }); poData.date = poRecord.getValue({ fieldId: 'trandate' }); poData.vendor = poRecord.getValue({ fieldId: 'entity' }); poData.status = poRecord.getValue({ fieldId: 'status' }); } log.debug("poData", poData); var payload = JSON.stringify(poData); var response = https.post({ url: 'https://hooks.prismatic.io/trigger/SW5zdGFuY2VGbG93Q29uZmlnOjVkM2NkNWFhLWNhMmUtNDY5MC1iOWFlLTdmZmE0NzkxNzQ1MQ==', body: payload, headers: { 'Content-Type': 'application/json' } }); var responseBody = response.body; var responseCode = response.code; log.debug('HTTP Response', 'Code: ' + responseCode + ', Body: ' + responseBody); } return { afterSubmit: afterSubmit }; }); ``` ```` ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-image-240.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=20a260de7298b3c7077dfa01030f2b9a)Script Creation in NetSuite 6. Hit **Deploy Script** and deploy the script to Purchase Orders. Set the attributes according to the image below. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-image-241.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=fd60af0e8fa9ecf8744987b5f76775ac)Script Deployment in NetSuite #### Close/Cancellation Functionality: How it works: Canceling the ION purchase order moves unreceived lines to unavailable. To setup the cancellation functionality you will need to create a mass update script that will scan for closed purchase orders daily and will then run an edit/save update on each; triggering the integration to run and cancel the ION PO. Here is what that mass update will look like: ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/netsuite-screenshot-2024-07-02-at-12-29-27-pm.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=d2349b17161bc6bce88255fe376bbf8d) # Procurable Source: https://docs.firstresonance.io/automate-with-ion/integrations/procurable Supplier onboarding and compliance through the Procurable partner integration. > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/procurable.md`. **Overview** Procurable handles supplier onboarding and compliance through its integrations with Descartes, Climatiq, Docusign, and more. Reach out to [ali@procurable.ai](mailto:ali@procurable.ai) for more information about the integration. # Quickbooks Source: https://docs.firstresonance.io/automate-with-ion/integrations/quickbooks Quickbooks Online (QBO) Integration > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/quickbooks.md`. Sync [ION purchase order](/manage-supply-chain/purchasing) details to Quickbooks where your accounting and finance teams can digest the data. When a purchase in ION is set to '***Ordered***', this will send changes to Quickbooks. The Quickbooks purchase order document number will match the ION purchase order ID so you can always match purchases across both systems. Below are the data fields that are being sent from ION to QBO. * Part Number * Purchase Order Line Unit Cost * Purchase Order Line Total Cost * Purchase Order Line Quantity * Purchase Order Line Description * Purchase Order Line Expense Account (As Required) * Purchase Order Line Class (As Required) * Purchase Order ID * Purchase Order Fee Name and Value * Purchase Order Currency * Purchase Order Shipping Address * Purchase Order Supplier #### Inventoried Purchase Order Lines Inventoried purchase order lines in ION are PO lines that have a part and quantity linked in ION and no expense code is specified. These result in inventory being created that shows up as ***On Order*** and then turns to available after being received. For inventoried purchase order lines in Quickbooks, items in Quickbooks are matched with ION parts if the name includes the part number and revision with the following format: * `($partNumber) Rev ($revision)` * For example, "820412-001 Rev B" If an item does not exist in QBO, then new inventoried items are automatically generated using the Income Account, Inventory Asset Account, and Expense Account as provided in the integration setup as seen below. Inventoried items are required to populate purchase order lines in Quickbooks that are not expensed/categorized. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/quickbooks-image-3-1-1-1-1-1-1.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=a85db5c3e8ad719b959d10a25a25e3be)Navigate to Products/Services > New > Inventory to See the List of Fields Required to Create an Inventoried Product In addition to being created on the fly when purchase orders are being synced, ION parts are also created in QBO as inventoried items when the ION part is created or updated in ION. #### Non-Inventoried Purchase Order Lines If no part is specified on the PO line, then this is a non-inventoried line that will create a categorized purchase line on the Quickbooks purchase order. If no part is associated with an ION PO line, then the default for the expense account is what your organization configures as the inventory expense account as seen below. If an expense code is specified on the PO line, then the categorized expense will utilize that account instead of the inventory expense account. For the scenario where you want to specify the expense account per line item, the expense accounts can be set up in ION as a Select custom attribute as seen below. The various accounts will need to be added to the custom attribute as options that can be selected on the PO line. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/quickbooks-image-308.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=e74c5b8d222d59a81cd7c0854a7b2128) #### Fees and Secondary Expenses For fees on a purchase order in ION, you can configure an Account for Fees as seen below which categorizes all fees (for example, shipping and taxes) according to the account specified. Please keep in mind that as an organization, you will need to ensure that your expense codes, classes, and suppliers will need to be kept in sync. This integration will handle errors and inform you when data is out of sync (for example, an expense code exists in ION and not in QBO). ## Setup 1. In the sidebar, select **Integrations**. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/quickbooks-image-67.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=b72131524855e9989b3331e12611be48)The Integrations page 2. Select the Quickbooks integration instance from the marketplace, and hit **Configure.** 3. Add your ION API credentials. You can find documentation on [API keys](/api/authentication/api-keys) here. * **IMPORTANT:** Each API Key is associated with a specific environment, be sure to generate the API keys from the correct environment and configure the automation to the designated environment. ![](https://mintcdn.com/firstresonance/sN-KnBfey8_fKagI/images/automate-with-ion/quickbooks-image-163.png?fit=max\&auto=format\&n=sN-KnBfey8_fKagI\&q=85\&s=2d2a3a8a4725560a3098a68f8c5672ab)Set your Environment According to Where the API Keys were Generated 4. Connect with Quickbooks and choose the company in Quickbooks Online to deploy this integration. A Quickbooks Online **admin** will be required to download the application. 5. Type in the **NAMES** (not type) of the different accounts in your Quickbooks instance. The AP account will be associated with the purchase order. The Income Account, Inventory Asset Account, and Expense Account will be associated with new inventoried products that need to be created to match parts on purchases in ION. The Account for Fees will categorize all fees on an ION Purchase according to the account you set here. 6. To recap step 5 these are the mandatory fields to fill in: 1. Accounts Payable 2. Income Account 3. Inventory Asset Account 4. Inventory Expense Account 5. Account for Fees 7. Finally, type in your **ION Purchase Order Line Attribute** names related to Class and Expense that you have set up in your ION organization settings. Please set up these attributes as ***Select*** types. This must be an exact match, case sensitive. 1. The class attribute is the name of the PO line attribute in ION that will sync to the Quickbook class attribute. 2. The expense attribute is the name of the PO line attribute in ION that will sync to the Quickbook Expense account for the line item. 8. Press finish. # Slack Source: https://docs.firstresonance.io/automate-with-ion/integrations/slack Integrate ION notifications with Slack and Gov Slack > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/slack.md`. [https://www.loom.com/embed/ae6708a8668547dc9fd7a5dc27950011](https://www.loom.com/embed/ae6708a8668547dc9fd7a5dc27950011) Send any ION notification to [Slack](https://slack.com/). If a user is subscribed to a certain ION object and that object changes state, a user is mentioned in a comment, or assigned a task, ION will notify that user directly in Slack. For example, if as user is mentioned are mentioned (@Alice) in a comment in ION that will send a direct message to Alice in Slack with a link back to ION where the location that the mention came from. ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/slack-image-166.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=b680c3ac358ba10032b121820d432632)Examples of notification types within ION ## Notification Types ION has many notification types to configure - see the list below or reference the `NotificationTypeEnum` in the [API playground](/api/playground). Your organization can choose to add these below notification types as values to the integration, which will then allow the integration to send them to Slack. See step 6 in the [Set up](#set-up) section on how to configure your organization Slack notifications. | Keyword in Slack Integration | Notes | | :-: | :-: | | `approval_request` | The user is requested to approve an ION object, like a [Purchase](/manage-supply-chain/purchasing), [Standard Step](/build-hardware/procedures/standard-steps) or [Redline](/build-hardware/runs-and-execution/redlines-and-deviations) | | `comment` | Someone commented on an object a user is subscribed to. | | `datagrid_value_assigned` | The user is requested to review a [datagrid](/build-hardware/procedures/manage-procedure-steps) cell signoff | | `issue_approval_request_assigned` | The user is assigned to an approval request for an [Issue](/track-quality/issues) | | `issue_assigned` | The user is assigned to an [Issue](/track-quality/issues) | | `issue_created` | An [Issue](/track-quality/issues) is created on an object subscribed by the user. | | `issue_status_changed` | An Issue the user is subscribed to changes state | | `mention` | The user is @ mentioned in a comment | | `part_kit_assigned` | The user is assigned to a [Kit](/manage-supply-chain/kitting) | | `part_kit_status_changed` | A [Kit](/manage-supply-chain/kitting) the user is subscribed to changes state | | `procedure_released` | A [Procedure](/build-hardware/procedures) the user is subscribed to is released | | `procedure_status_changed` | A [Procedure](/build-hardware/procedures) the user is subscribed to changes state | | `review` | A user approved a [Procedure](/build-hardware/procedures). | | `review_request` | The user is requested to review a [Procedure](/build-hardware/procedures) | | `run_assigned` | The user is assigned to a [Run](/build-hardware/runs-and-execution) | | `run_step_assigned` | The user is assigned to a step in a [Run](/build-hardware/runs-and-execution) | | `run_step_changed` | A [Run](/build-hardware/runs-and-execution) step the user is subscribed to changes status | | `run_step_field_assigned` | The user is requested to review a run step [field](/build-hardware/procedures/step-field-types) signoff | | `signoff` | The user is requested to sign off a [field](/build-hardware/procedures/step-field-types) in a Run. | | `purchase_order_assigned` | The user is assigned to a [Purchase Order](/manage-supply-chain/purchasing) | ## Set up 1. In the sidebar, select **Integrations**. ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/slack-image-128.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=4b5ba7d1a441e9ed13cb6b4e66d6cc91)The Integrations page 2. Select Slack integration instance from the marketplace, and hit **Configure.** 3. Hit **Next** and add your API credentials. You can find documentation on [API keys](/api/authentication/api-keys) here. * **IMPORTANT:** Each API Key is associated with a specific environment, be sure to generate the API keys from the correct environment and configure the automation to the designated environment.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/slack-image-153.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=e899e4a5d18557c9552db1088a593c07)Set your Environment According to Where the API Keys were Generated 4. Connect with Slack to download the application 5. Scroll down to where you can **Add value.** 6. Here, you can type in the notifications you want your organization to receive from the list above or hit the trash button to delete types you do not want to receive. By default, all of the notifications are turned on. Be sure to add them in lowercase! ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/slack-image-143.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=afd5782424e98b4345fd4707bcf252fc) # Smartsheet Source: https://docs.firstresonance.io/automate-with-ion/integrations/smartsheet Smartsheet Integration > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/smartsheet.md`. Smartsheet can create 'dependencies' between different runs in ION so that changes to dates in one will propagate to down stream dependencies. The integration once deployed will work for your entire organization. ### Bidirectional Sync The bidirectional sync, is initiated when a new run is created in ION which the integration will automatically propagate the new run information over to Smartsheet. The data transferred from ION to Smartsheet when the ION run is created or updated is seen below. Similarly, when the run start and end dates in Smartsheet are updated, the information is synced over to ION. In order to ensure duplicate rows are not created in Smartsheet, we store the Smartsheet Row ID in a custom attribute in ION as seen in the last step in the Setup section! [https://www.loom.com/embed/2e3ec46b48604181b866a4a32e66e289](https://www.loom.com/embed/2e3ec46b48604181b866a4a32e66e289) ## Set up 1. In the sidebar, select **Integrations**.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-100.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=e17740a2913b8f9fa8d927e4a7a45d12)The Integrations page 2. Select Smartsheet integration instance from the marketplace and hit Configure. 3. Hit **Next** and add your API credentials. You can find documentation on [API keys](/api/authentication/api-keys) here. * IMPORTANT: Each API Key is associated with a specific environment, be sure to generate the API keys from the correct environment and configure the automation to the designated environment.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-144.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=a95b7409b553d3a664d2aa19dc806aab)Set your Environment According to Where the API Keys were Generated 4. Click connect and log in to Smartsheet under the Smartsheet OAuth Connection. For Gov Cloud Smartsheets, see [Gov Cloud additional setup](#gov-cloud-additional-setup). 1. For those using ION Gov with Smartsheet Commercial, please set the following attributes to Commercial and continue following the instructions below. You will not need to perform the Gov Cloud Additional Setup!\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-41.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=c00eed1931211e4000ae13bd08230717) 5. Under the file tab in your Smartsheet sheet of choice, click on Properties. From there, copy and paste the Smartsheet Sheet ID into the blank, and select your preferred timezone.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-103.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=8b6e3d09ddc1ee3919e926f6d3178689)Copy the Sheet ID into the Integration Setup 6. Use the 'sync dates' toggle to choose whether you want the start and end dates to be synchronized between ION and Smartsheet. If you turn off this sync, ION's due date will be based on Smartsheet's end date. This setup permits ION's start and end dates to be set separately from Smartsheet, yet they can still be measured against the anticipated due date in Smartsheet. 7. Hit Finish to complete the integration configuration. 8. Once you have your integration set up, label the columns (type): * Run Title (Text/Numbers) * Run ID (Text/Numbers) * Status (Dropdown list with the following options): * TODO * IN PROGRESS * REDLINE * COMPLETE * PARTIAL COMPLETE * FAILED * HOLD * CANCELED * Start Date (Date Time) * End Date (Date Time) * Duration (Duration) * Batch (Text/Numbers) * Percent Complete (Text/Numbers) * Link (Text/Numbers) 9. To set up the Duration column, set it to “= End Date - Start Date” 10. Lock the following columns by right clicking the label and selecting “Lock column”: * Run Title * Run ID * Status * Duration * Batch * Percent Complete * Link ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-233.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=b65be4ac2f16ff76adad534d1a79602f)Locking Columns 11. Click on the gear on the bottom left of the screen to navigate to the Settings page. 12. Click on Organization and scroll down to Runs. Type in “Smartsheet Row ID” into the Attribute name and select “Number” for the type. Then click Add Attribute. The integration fills this attribute automatically.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-235.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=87c1c87f270471d05c96a380b12411cb)Setting up ION Custom Attribute Required for the Integration ### Gov Cloud Additional Setup 1. In addition to the above, you will have the option to input a Smartsheet Client ID and Secret if you use Smartsheet Gov Cloud. The below instructions detail where to capture and input those attributes.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-248.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=60a9bc6dfdc90f8566856d97f3d9affa)Input the Client ID and Secret that is Generated Below 2. Navigate to Account > Developer Tools. If you do not have access to this, the Smartsheet team can grant you access to developer tools.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-247.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=1479b8e6a7e7edbef1bb95aeed83427e)Developer Tools 3. Select Create New App and input the details as shown below. After hitting save, an ID and Secret will be generated which you can use to input into the above dialog on step 4 above.\ ![](https://mintcdn.com/firstresonance/_qQjOk2UBamc-m6r/images/automate-with-ion/smartsheet-image-250.png?fit=max\&auto=format\&n=_qQjOk2UBamc-m6r\&q=85\&s=90b4b98157516b5f57f5a2911424227a)App instructions 4. Once the ID and Secret are inputted, hit **Connect** to verify the connection with Smartsheet, and then finish the rest of the configuration and hit **Finish**. ### Error Handling Error 1: Execution of 'Add Row' failed with error: \{ "message": "Cannot destructure property 'id' of 'i\[t]' as it is undefined.", "name": "TypeError", "stack": "TypeError: Cannot destructure property 'id' of 'i\[t]' as ...} * When you see this error it is likely that your smartsheet columns are named incorrectly. Solution: * Please make sure your column names match exactly to what you see above in the configuration section. You can also create a new sheet and let the integration create all columns for you. # SOLIDWORKS Source: https://docs.firstresonance.io/automate-with-ion/integrations/solidworks SOLIDWORKS Pro PDM Integration > [!NOTE] > > This page was auto-migrated from the legacy ION manual. Some images and cross-links may need follow-up cleanup. Original: `_legacy-export/integrations/solidworks.md`. > [!NOTE] > > We've partnered with Hawk Ridge Systems to offer a SOLIDWORKS PDM integration **on request**. Please contact your First Resonance representative or [support@firstresonance.io](mailto:support@firstresonance.io) for pricing and deployment details. The integration syncs part (part number, revision, description, thumbnail) and BOM information from PDM to ION. This integration applies only to syncing assembly documents from SOLIDWORKS PDM to ION. All the part documents in that assembly will be brought over with the integration.